跳转到主要内容
API Explorer|API Explorer
存储管理/数据存储相关接口/SAN存储相关接口/NVMe存储相关接口
POSTNVMe Storage Related Interfaces起始版本 4.7.21同步需要认证

添加NVMe服务器

添加NVMe服务器

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • nameString

    资源名称。

  • ipString必填

    来源IP地址。

  • portInteger

    端口号。

  • transportString必填

    目标transport类型。

  • resourceUuidString

    资源UUID。若指定，资源会使用该字段值作为UUID。

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • inventoryNvmeServerInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • ipString必填

      来源IP地址。

    • portInteger必填

      端口号。

    • stateString必填

      当前状态。

    • transportString必填

      暂无描述。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • nvmeTargetsList必填

      详情参考nvmeTargets

      • uuidString必填

        资源的UUID，唯一标示该资源

      • nameString必填

        资源名称

      • nqnString必填

        NVMe 限定名称

      • nvmeServerUuidString必填

        nvme服务器UUID

      • stateString必填

        状态

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

      • nvmeLunsList必填

        详情参考nvmeLuns

        • nvmeTargetUuidString必填

          所属NVMe设备UUID

        • nameString必填

          资源名称

        • uuidString必填

          资源的UUID，唯一标示该资源

        • wwidString必填

          全局唯一标识

        • vendorString必填

          供应商

        • modelString必填

          型号

        • wwnString必填

          暂无描述。

        • serialString必填

          序列号

        • typeString必填

          类型

        • hctlString必填

          暂无描述。

        • pathString必填

          路径

        • stateString必填

          状态

        • sizeLong必填

          大小

        • multipathDeviceUuidString必填

          多路径设备UUID

        • sourceString必填

          磁盘来源，NVMe

        • createDateTimestamp必填

          创建时间

        • lastOpDateTimestamp必填

          最后一次修改时间

        • nvmeLunHostRefsList必填

          详情参考nvmeLunHostRefs

          • nvmeLunUuidString必填

            NVMe磁盘UUID

          • hostUuidString必填

            主机UUID

          • pathString必填

            磁盘路径

          • hctlString必填

            磁盘HCTL

          • createDateTimestamp必填

            创建时间

          • lastOpDateTimestamp必填

            最后一次修改时间

    • nvmeClusterRefsList必填

      详情参考nvmeClusterRefs

      • nvmeServerUuidString必填

        暂无描述。

      • clusterUuidString必填

        集群UUID

      • createDateTimestamp必填

        创建时间

      • lastOpDateTimestamp必填

        最后一次修改时间

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

请求地址

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

/zstack/v1/storage-devices/nvme/servers

操作 ID

AddNvmeServer

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/storage-devices/nvme/servers' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"name":"<name>","ip":"<ip>","port":1,"transport":"<transport>","resourceUuid":"<resourceUuid>","tagUuids":["<tagUuids>"],"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "13b261814cc036629e76e2e218d3c764", "name": "nvme-server-10.0.0.201", "ip": "10.0.0.201", "port": 3260, "state": "Enabled", "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史