Skip to main content
API Explorer|API Explorer
Storage Management/Data Storage APIs/SAN Storage Related Interfaces/NVMe Storage Related Interfaces
GETNVMe Storage Related InterfacesSince 4.6.21SynchronousAuth Required

Query NVMe Target

Query NVMe Target

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    Error code. If not null, the operation failed. If null, the operation succeeded. For details, see error

    • codeStringRequired

      Error code number, globally unique identifier of the error, for example SYS.1000, HOST.1001

    • descriptionStringRequired

      Brief summary of the error

    • detailsStringRequired

      Detailed error information

    • elaborationStringRequired

      Reserved field, defaults to null

    • opaqueLinkedHashMapRequired

      Reserved field, defaults to null

    • causeErrorCodeRequired

      Root cause: the source error that triggered the current error. If there is no original error, this field is null

  • inventoriesListRequired

    For details, see inventories

    • uuidStringRequired

      Resource UUID, uniquely identifies the resource

    • nameStringRequired

      Resource name

    • nqnStringRequired

      NVMe Qualified Name

    • stateStringRequired

      State

    • createDateTimestampRequired

      Creation time

    • lastOpDateTimestampRequired

      Last modification time

    • nvmeLunsListRequired

      For details, see nvmeLuns

      • nvmeTargetUuidStringRequired

        NVMe device UUID

      • nameStringRequired

        Resource name

      • uuidStringRequired

        Resource UUID, uniquely identifies the resource

      • wwidStringRequired

        Global unique identifier

      • vendorStringRequired

        Vendor

      • modelStringRequired

        Model

      • wwnStringRequired

        No description provided.

      • serialStringRequired

        Serial number

      • typeStringRequired

        Type

      • hctlStringRequired

        No description provided.

      • pathStringRequired

        Path

      • stateStringRequired

        State

      • sizeLongRequired

        Size

      • multipathDeviceUuidStringRequired

        Multipath device UUID

      • sourceStringRequired

        Disk source, NVMe

      • createDateTimestampRequired

        Creation time

      • lastOpDateTimestampRequired

        Last modification time

      • nvmeLunHostRefsListRequired

        For details, see nvmeLunHostRefs

        • nvmeLunUuidListRequired

          NVMe disk UUID

        • hostUuidStringRequired

          Host UUID

        • pathStringRequired

          Disk path

        • hctlStringRequired

          Disk HCTL

        • createDateTimestampRequired

          Creation time

        • lastOpDateTimestampRequired

          Last modification time

Endpoint

GET/zstack/v1/storage-devices/nvme/controllers

/zstack/v1/storage-devices/nvme/controllers

Operation ID

QueryNvmeTarget

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/storage-devices/nvme/controllers' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "inventories": [ { "uuid": "40ab069909633d4293c62f44efb26db8", "state": "Enabled", "nvmeLuns": [ { "nvmeTargetUuid": "40ab069909633d4293c62f44efb26db8", "nvmeLunHostRefs": [ { "id": 1, "nvmeLunUuid": "5690b46050623763a0335e753c347fa1", "hostUuid": "d6f8a7ff0069304080b345c077c3aeb9", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ], "name": "nvme-lun-36b083fe000daf018000022905ba35d8f", "uuid": "5690b46050623763a0335e753c347fa1", "wwid": "uuid.48daeab7-7f15-405e-8481-7152cb9b0aca", "wwn": "uuid.48daeab7-7f15-405e-8481-7152cb9b0aca", "serial": "3d87eca1686c1782", "type": "disk", "path": "nvme-uuid.48daeab7-7f15-405e-8481-7152cb9b0aca ", "size": 5497558138880 } ], "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ] }

Change History

This API has no change history records yet.

View all change history