Skip to main content
API Explorer|API Explorer
Resource Center/Hardware/SAN Storage Operations/NVMe Storage Operations
POSTNVMe Storage OperationsSince 4.6.21SynchronousAuth Required

RefreshNvmeTarget

RefreshNvmeTarget

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • zoneUuidStringRequired

    The zone UUID.

  • nvmeLunUuidsList

    Optional. The NVMe disk UUID.

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    操作是否成功。

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • codeStringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • descriptionStringRequired

      The brief description of the error.

    • detailsStringRequired

      The details about the error.

    • elaborationStringRequired

      The reserved field. Default value: null.

    • opaqueLinkedHashMapRequired

      The reserved field. Default value: null.

    • causeErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • inventoriesListRequired

    See inventories.

    • uuidStringRequired

      The resource UUID.

    • nameStringRequired

      The resource name.

    • nqnStringRequired

      The unique name for the NVMe.

    • stateStringRequired

      The state.

    • createDateTimestampRequired

      The creation date.

    • lastOpDateTimestampRequired

      The last operation date.

    • nvmeLunsListRequired

      See nvmeLuns.

      • nvmeTargetUuidStringRequired

        The NVMe device UUID.

      • nameStringRequired

        The resource name.

      • uuidStringRequired

        The resource uuid.

      • wwidStringRequired

        The unique tag of the resource.

      • vendorStringRequired

        The vendor供应商

      • modelStringRequired

        The model

      • wwnStringRequired

        No description provided.

      • serialStringRequired

        The serial.

      • typeStringRequired

        The type.

      • hctlStringRequired

        No description provided.

      • pathStringRequired

        The path.

      • stateStringRequired

        The state.

      • sizeLongRequired

        The size.

      • multipathDeviceUuidStringRequired

        The UUID of the multi-path device.

      • sourceStringRequired

        The disk source, NVME.

      • createDateTimestampRequired

        The creation date.

      • lastOpDateTimestampRequired

        The last operation date.

      • nvmeLunHostRefsListRequired

        See nvmeLunHostRefs.

        • nvmeLunUuidListRequired

          The UUID of the NVMe disk.

        • hostUuidStringRequired

          The host UUID.

        • pathStringRequired

          The disk path.

        • hctlStringRequired

          The disk HCTL.

        • createDateTimestampRequired

          The creation date.

        • lastOpDateTimestampRequired

          The last operation date.

Endpoint

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

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

Operation ID

RefreshNvmeTarget

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/storage-devices/nvme/controllers' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"zoneUuid":"<zoneUuid>","nvmeLunUuids":["<nvmeLunUuids>"],"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventories": [ { "uuid": "88ed12f1c3d7329c9b3fd00a87ce999e", "state": "Enabled", "nvmeLuns": [ { "nvmeTargetUuid": "88ed12f1c3d7329c9b3fd00a87ce999e", "nvmeLunHostRefs": [ { "id": 1, "nvmeLunUuid": "3adbd21bfa483cb2bc48b91c1438c788", "hostUuid": "8c26dfd50d963292b8a51ddc0f9957f5", "createDate": "Nov 14, 2017 10:20:57 PM", "lastOpDate": "Nov 14, 2017 10:20:57 PM" } ], "name": "nvme-lun-36b083fe000daf018000022905ba35d8f", "uuid": "3adbd21bfa483cb2bc48b91c1438c788", "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