查询镜像存储

GET/zstack/v1/backup-storage
GET/zstack/v1/backup-storage/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth dce9c25b65254343b0f9a568a661f348" \
-X GET http://localhost:8080/zstack/v1/backup-storage?q=uuid=435e61f882cf431bb4ae48246489a988
curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth fe9a6571fc9949e7a0d31d94fae9b87c" \
-X GET http://localhost:8080/zstack/v1/backup-storage/1ab3b836a88342e1bbc1b1a17d092f0f

可查询字段

运行CLI命令行工具,输入QueryBackupStorage并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例(单机镜像仓库)

{
  "inventories": [
    {
      "attachedZoneUuids": [
        "140ebc2fbdb74ae197323a69d432f25e"
      ],
      "availableCapacity": 4931431059456,
      "createDate": "Apr 11, 2018 2:50:54 PM",
      "description": "",
      "hostname": "172.20.1.115",
      "lastOpDate": "Dec 13, 2019 7:32:49 PM",
      "name": "image-store",
      "sshPort": 22,
      "state": "Enabled",
      "status": "Connected",
      "totalCapacity": 9992857976832,
      "type": "ImageStoreBackupStorage",
      "url": "/zstack_imagestore",
      "username": "root",
      "uuid": "1ab3b836a88342e1bbc1b1a17d092f0f"
    }
  ],
  "success": true
}

返回示例(分布式镜像仓库)

{
  "inventories": [
    {
      "attachedZoneUuids": [
        "195ae9157b9248e3889cc56cfd7d0f8d"
      ],
      "availableCapacity": 297500737536,
      "createDate": "Dec 14, 2019 9:46:05 AM",
      "description": "Test",
      "fsid": "d53902bc-ff50-4d08-8769-9d83448478d3",
      "lastOpDate": "Dec 14, 2019 11:30:40 AM",
      "mons": [
        {
          "backupStorageUuid": "eed424abee694bcda5a5e414a61ea3d3",
          "createDate": "Dec 14, 2019 9:46:05 AM",
          "hostname": "172.24.249.174",
          "lastOpDate": "Dec 14, 2019 11:21:46 AM",
          "monAddr": "172.24.249.174",
          "monPort": 6789,
          "monUuid": "e6707015afc8405ba0b184ca7a318b63",
          "sshPassword": "password",
          "sshPort": 22,
          "sshUsername": "root",
          "status": "Connected"
        },
        {
          "backupStorageUuid": "eed424abee694bcda5a5e414a61ea3d3",
          "createDate": "Dec 14, 2019 9:46:05 AM",
          "hostname": "172.24.252.188",
          "lastOpDate": "Dec 14, 2019 11:21:45 AM",
          "monAddr": "172.24.252.188",
          "monPort": 6789,
          "monUuid": "d5e70424ddac4c03ab06466d600ef4ae",
          "sshPassword": "password",
          "sshPort": 22,
          "sshUsername": "root",
          "status": "Connected"
        },
        {
          "backupStorageUuid": "eed424abee694bcda5a5e414a61ea3d3",
          "createDate": "Dec 14, 2019 9:46:05 AM",
          "hostname": "172.24.247.108",
          "lastOpDate": "Dec 14, 2019 11:21:16 AM",
          "monAddr": "172.24.247.108",
          "monPort": 6789,
          "monUuid": "378826f5f690480983f39514e0b00f75",
          "sshPassword": "password",
          "sshPort": 22,
          "sshUsername": "root",
          "status": "Connected"
        }
      ],
      "name": "ceph-bs",
      "poolAvailableCapacity": 99166913877,
      "poolName": "bak-t-eed424abee694bcda5a5e414a61ea3d3",
      "poolReplicatedSize": 3,
      "poolUsedCapacity": 2787687082,
      "state": "Enabled",
      "status": "Connected",
      "totalCapacity": 305863802880,
      "type": "Ceph",
      "url": "not used",
      "uuid": "eed424abee694bcda5a5e414a61ea3d3"
    }
  ],
  "success": true
}
名字类型描述起始版本
errorErrorCode错误码,若不为null,则表示操作失败, 操作成功时该字段为null。 详情参考error0.6
inventoriesList详情参考inventories0.6

error

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

inventories

名字类型描述起始版本
uuidString资源的UUID,唯一标示该资源0.6
nameString资源名称0.6
urlString 0.6
descriptionString资源的详细描述0.6
totalCapacityLong 0.6
availableCapacityLong 0.6
typeString 0.6
stateString 0.6
statusString 0.6
createDateTimestamp创建时间0.6
lastOpDateTimestamp最后一次修改时间0.6
attachedZoneUuidsList 0.6

SDK示例

Java SDK

QueryBackupStorageAction action = new QueryBackupStorageAction();
action.conditions = asList("uuid=b8e17834373747ae8b6555db80e74586");
action.sessionId = "f5d478c4facf42f4a3f16c8efbfd9628";
QueryBackupStorageAction.Result res = action.call();

Python SDK

QueryBackupStorageAction action = QueryBackupStorageAction()
action.conditions = ["uuid=0359113913834277bc815b446a6eff25"]
action.sessionId = "dc56b36c279f449ea2d430d2513a4cb0"
QueryBackupStorageAction.Result res = action.call()