跳转到主要内容
API Explorer|API Explorer
存储管理/数据存储相关接口
POSTData Storage APIs起始版本 5.0.0同步需要认证

发现外部存储

发现外部存储

调试可用性

在线调试

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

请求参数

请求体字段

  • paramsObject必填

    请求体参数结构

    • urlString必填

      地址。

    • identityString

      存储标识

    • configString

      配置

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • inventoryExternalPrimaryStorageInventory必填

    详情参考inventory

    • identityString必填

      存储标识

    • configString必填

      配置

    • addonInfoString必填

      额外信息

    • outputProtocolsList必填

      可输出协议

    • defaultProtocolString必填

      默认协议

    • uuidString必填

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

    • zoneUuidString必填

      数据中心UUID

    • nameString必填

      资源名称

    • urlString必填

      地址。

    • descriptionString必填

      资源的详细描述

    • totalCapacityLong必填

      总容量。

    • availableCapacityLong必填

      可用容量。

    • totalPhysicalCapacityLong必填

      总物理容量。

    • availablePhysicalCapacityLong必填

      可用物理容量。

    • systemUsedCapacityLong必填

      系统已使用容量。

    • typeString必填

      类型

    • stateString必填

      当前状态。

    • statusString必填

      状态信息。

    • mountPathString必填

      mount路径。

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • attachedClusterUuidsList必填

      附加集群UUID。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

POST/zstack/v1/primary-storage/addon/discover

/zstack/v1/primary-storage/addon/discover

操作 ID

DiscoverExternalPrimaryStorage

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/primary-storage/addon/discover' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"params":{"url":"<url>","identity":"<identity>","config":"<config>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "identity": "expon", "addonInfo": { "pools": [ { "name": "pool1", "availableCapacity": 100, "totalCapacity": 200 }, { "name": "pool2", "availableCapacity": 100, "totalCapacity": 200 } ] }, "uuid": "2cb103e920c034b7a709b9cc7e0394b8", "url": "http://operator:*****@172.25.1.5:80", "totalCapacity": 107374182400, "availableCapacity": 53687091200, "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史