分布式存储相关接口

添加分布式存储

POST/zstack/v1/primary-storage/ceph

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "monUrls": [
      "root:password@localhost/?monPort=7777"
    ],
    "rootVolumePoolName": "zs-images",
    "dataVolumePoolName": "zs-data-volume",
    "imageCachePoolName": "zs-image-cache",
    "name": "My Ceph Primary Storage",
    "zoneUuid": "d42197a462c34a44989bdf38d5aa2424"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"monUrls":["root:password@localhost/?monPort=7777"],"rootVolumePoolName":"zs-images","dataVolumePoolName":"zs-data-volume","imageCachePoolName":"zs-image-cache","name":"My Ceph Primary Storage","zoneUuid":"251a3dffccaf39fc8d190eedcf4395bf"}}' \
http://localhost:8080/zstack/v1/primary-storage/ceph

参数列表

名字类型位置描述可选值起始版本
monUrlsListbody(包含在params结构中)分布式存储 mon 的地址列表 0.6
rootVolumePoolName (可选)Stringbody(包含在params结构中)指定 Root Volume 可使用的 分布式存储 pool 名字 0.6
dataVolumePoolName (可选)Stringbody(包含在params结构中)指定 Data Volume 可使用的分布式存储 pool 名字 0.6
imageCachePoolName (可选)Stringbody(包含在params结构中)指定镜像缓存可使用的分布式存储 pool 名字 0.6
urlStringbody(包含在params结构中)未使用 0.6
nameStringbody(包含在params结构中)分布式存储的名称 0.6
description (可选)Stringbody(包含在params结构中)分布式存储的详细描述 0.6
type (可选)Stringbody(包含在params结构中)分布式存储的类型，此处为 Ceph 0.6
zoneUuidStringbody(包含在params结构中)数据中心UUID 0.6
resourceUuid (可选)Stringbody(包含在params结构中)资源UUID。若指定，分布式存储会使用该字段值作为UUID。 0.6
systemTags (可选)Listbody系统标签 0.6
userTags (可选)Listbody用户标签 0.6
  • ZSvirt添加分布式存储时支持标识分布式存储的类型为xsky、sandstone、或open-source，SystemTags增加manufacturer选项。
  • 选项格式为：ceph::manufacturer::Platform
  • 例如：ceph::manufacturer::xsky
  • ZSvirt添加分布式存储时支持标识分布式存储的类型为xsky，且支持调用xsky类型分布式存储的SDK，SystemTags增加thirdPartyPlatform选项。
    • 选项格式为：ceph::thirdPartyPlatform::TOKEN
    • 例如：ceph::thirdPartyPlatform::68b329da9893e34099c7d8ad5cb9c940

API返回

返回示例

{
  "inventory": {
    "name": "Ceph-1",
    "url": "not used",
    "type": "Ceph",
    "state": "Enabled",
    "status": "Connected",
    "attachedClusterUuids": [
      "2d8583d86bd1472e8ec0e04e26ea273f"
    ]
  }
}
名字类型描述起始版本
errorErrorCode错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error0.6
inventoryPrimaryStorageInventory详情参考inventory0.6

error

名字类型描述起始版本
codeString错误码号，错误的全局唯一标识，例如SYS.1000, HOST.10010.6
descriptionString错误的概要描述0.6
detailsString错误的详细信息0.6
elaborationString保留字段，默认为null0.6
opaqueLinkedHashMap保留字段，默认为null0.6
causeErrorCode根错误，引发当前错误的源错误，若无原错误，该字段为null0.6

inventory

名字类型描述起始版本
uuidString资源的UUID，唯一标示该资源0.6
zoneUuidString数据中心UUID0.6
nameString资源名称0.6
urlString 0.6
descriptionString资源的详细描述0.6
totalCapacityLong 0.6
availableCapacityLong 0.6
totalPhysicalCapacityLong 0.6
availablePhysicalCapacityLong 0.6
systemUsedCapacityLong 0.6
typeString 0.6
stateString 0.6
statusString 0.6
mountPathString 0.6
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6
attachedClusterUuidsList 0.6

SDK示例

Java SDK

AddCephPrimaryStorageAction action = new AddCephPrimaryStorageAction();
action.monUrls = asList("root:password@localhost/?monPort=7777");
action.rootVolumePoolName = "zs-images";
action.dataVolumePoolName = "zs-data-volume";
action.imageCachePoolName = "zs-image-cache";
action.name = "My Ceph Primary Storage";
action.zoneUuid = "88b49879acd34e11afa5bb3ea9164d5a";
action.sessionId = "33a01ee65ac64450940359dc3181f9b1";
AddCephPrimaryStorageAction.Result res = action.call();

Python SDK

AddCephPrimaryStorageAction action = AddCephPrimaryStorageAction()
action.monUrls = [root:password@localhost/?monPort=7777]
action.rootVolumePoolName = "zs-images"
action.dataVolumePoolName = "zs-data-volume"
action.imageCachePoolName = "zs-image-cache"
action.name = "My Ceph Primary Storage"
action.zoneUuid = "0f05052514554462b437f9cfa272f57f"
action.sessionId = "cb3d5ecb63634ca093ea223c55e6a30a"
AddCephPrimaryStorageAction.Result res = action.call()

分布式存储相关接口

上一页

GET查询分布式存储

下一页