Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Thanks for using the TrueNAS Community Edition issue tracker! TrueNAS Enterprise users receive direct support for their reports from our support portal.

Issues

Select view

Select search mode

 
1-50 of 56
1 of 56

RESTful API 2.0 bug with /disk/id/{id}

Complete

Description

As discussed in this forum thread https://www.truenas.com/community/threads/how-to-discover-disk-uids-for-freenas-http-api-v2-0.86968/ there is an Issue with the

/disk/id/{id}

RESTful API 2.0 call, because disks don’t have a numeric ID assigned to them. To fix this, the config database scheme would need to be changed to include a numeric ID or the RESTful API wrapper would need to accept “string” typed IDs, too, either via GET/POST body or as URI component, but the latter would mean that the current “identifier” values need to be URLencoded before putting them in the URI because of special chars…

If one isn’t limited to RESTful API 2.0, there are workarounds like using ‘midclt’ to call the needed method as described in the forum post. But you either need shell access or use websocket API to use the workaround, which might not be feasible for everyone.

Here is what currently happens when I try to GET disk id 0:

curl -X GET "https://hostname/api/v2.0/disk/id/0" -H "accept: */*" -H "Authorization: Bearer $APIKEY" -H "Content-Type: application/json" | sed 's/\\n/\n/g' { "message": "'id'", "traceback": "Traceback (most recent call last): File \"/usr/local/lib/python3.9/site-packages/middlewared/restful.py\", line 580, in do result = await self.middleware.call(methodname, *method_args, **method_kwargs) File \"/usr/local/lib/python3.9/site-packages/middlewared/main.py\", line 1279, in call return await self._call( File \"/usr/local/lib/python3.9/site-packages/middlewared/main.py\", line 1236, in _call return await methodobj(*prepared_call.args) File \"/usr/local/lib/python3.9/site-packages/middlewared/schema.py\", line 975, in nf return await f(*args, **kwargs) File \"/usr/local/lib/python3.9/site-packages/middlewared/plugins/disk.py\", line 89, in query return await super().query(filters, options) File \"/usr/local/lib/python3.9/site-packages/middlewared/schema.py\", line 975, in nf return await f(*args, **kwargs) File \"/usr/local/lib/python3.9/site-packages/middlewared/service.py\", line 490, in query return await self.middleware.call( File \"/usr/local/lib/python3.9/site-packages/middlewared/main.py\", line 1279, in call return await self._call( File \"/usr/local/lib/python3.9/site-packages/middlewared/main.py\", line 1236, in _call return await methodobj(*prepared_call.args) File \"/usr/local/lib/python3.9/site-packages/middlewared/schema.py\", line 975, in nf return await f(*args, **kwargs) File \"/usr/local/lib/python3.9/site-packages/middlewared/plugins/datastore/read.py\", line 102, in query qs = qs.where(and_(*self._filters_to_queryset(filters, table, prefix, aliases))) File \"/usr/local/lib/python3.9/site-packages/middlewared/plugins/datastore/filter.py\", line 51, in _filters_to_queryset col = self._get_col(table, name, prefix) File \"/usr/local/lib/python3.9/site-packages/middlewared/plugins/datastore/schema.py\", line 23, in _get_col raise KeyError(name) KeyError: 'id' " }#

As you can see, there is no ‘id’ listed when querying a disk:

curl -X GET "https://hostname/api/v2.0/disk" -H "accept: */*" -H "Authorization: Bearer $APIKEY" -H "Content-Type: application/json" -d '{"query-filters":[],"query-options":{"limit":1}}' [ { "identifier": "{serial_lunid}REPLACED _5000000000000000", "name": "da118", "subsystem": "da", "number": 118, "serial": "REPLACED", "lunid": "5000000000000000", "size": 3000592982016, "multipath_name": "disk23", "multipath_member": "da141", "description": "", "transfermode": "Auto", "hddstandby": "ALWAYS ON", "hddstandby_force": false, "advpowermgmt": "DISABLED", "acousticlevel": "DISABLED", "togglesmart": true, "smartoptions": "", "expiretime": null, "critical": null, "difference": null, "informational": null, "model": "HITACHI HUASOMETHING", "rotationrate": 7200, "type": "HDD", "zfs_guid": "5973852185995294423", "bus": "MPS", "devname": "multipath/disk23", "enclosure": null, "pool": null } ]#

This issue exists at least since Version 11.3-U3.1 and since in 13.0-U4 it’s still the same, I guess that the bug is in all releases inbetween those two.

Problem/Justification

None

Impact

None
Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Labels

Impact

Medium

Time remaining

0m

Components

Fix versions

Affects versions

Priority

Katalon Platform

Created June 1, 2023 at 9:45 AM
Updated August 11, 2023 at 9:46 AM
Resolved June 20, 2023 at 8:25 AM
Configure

Activity

Show:

Automation for Jira June 20, 2023 at 8:25 AM

This issue has now been closed. Comments made after this point may not be viewed by the TrueNAS Teams. Please open a new issue if you have found a problem or need to re-engage with the TrueNAS Engineering Teams.

Bug Clerk June 20, 2023 at 7:25 AM

Vladimir Vinogradenko June 20, 2023 at 7:23 AM

Non-numeric identifiers work for me on 23.10

root@truenas[~/freenas/freenas/tests]# curl -u root:password localhost/api/v2.0/disk/id/%7Bserial%7DVB3fadf901-46ac94df/ { "identifier": "{serial}VB3fadf901-46ac94df", "name": "sda", ...

Christian Marg June 13, 2023 at 8:27 AM
Edited

Yes, I tried that to no avail via URLencode and GET-Body - the RESTful API 2.0 wrapper expects an integer value, `identifier` is a string…
See also the Post of the Forum Moderator Samuel Tai: https://www.truenas.com/community/threads/how-to-discover-disk-uids-for-freenas-http-api-v2-0.86968/post-762795 :

Yes, this is a bug in the RESTful 2.0 API. The API call works correctly using midclt call disk.update '{serial_lunid}P4HEY9UC_5000cca249d46e61' '{"smartoptions":"-d sat"}'. The basic issue is the dictionary for the storage_disk table in the configuration database doesn't have a field corresponding to id.

William Gryzbowski June 12, 2023 at 6:04 PM

Did you try using “identifier" ?