调用DescribeVaults获取一个或者多个符合条件的备份仓库信息。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeVaults

系统规定参数。取值:DescribeVaults

VaultId String v-*********************

备份仓库ID。

VaultRegionId String cn-shanghai

备份仓库所属的地域ID。

Status String CREATED

备份仓库状态。

  • UNKNOWN:未知
  • INITIALIZING:初始化中
  • CREATED:已创建
  • ERROR:错误
PageNumber Integer 1

分页页码,从1开始,默认值1。

PageSize Integer 10

分页大小,最小值1,最大值99,默认值10。

VaultType String STANDARD

备份仓库类型。取值仅为STANDARD,表示普通仓库。

Tag.N.Key String TestKey

仓库的标签键。N的取值范围:1~20。

  • 不支持以aliyunacs:开头。
  • 不允许包含http://https://
  • 不允许为空字符串。
Tag.N.Value String TestValue

仓库的标签值。N的取值范围:1~20。

  • 不支持以aliyunacs:开头。
  • 不允许包含http://https://
  • 不允许为空字符串。
ResourceGroupId String rg-*********************

资源组ID。

返回数据

名称 类型 示例值 描述
Code String 200

返回码。200表示成功。

Message String successful

返回信息描述,成功一般返回successful,错误时会返回相应错误信息。

PageNumber Integer 1

分页页码。

PageSize Integer 10

分页大小。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

Success Boolean true

请求是否成功。

  • true表示成功。
  • false表示失败。
TotalCount Integer 8

返回备份仓库总数量。

Vaults Array of Vault

备份仓库列表。

Vault
BytesDone Long 20

备份数据量。单位为Byte。

CreatedTime Long 1554347313

备份仓库创建时间。UNIX时间,单位秒。

Description String vault description

仓库描述。

LatestReplicationTime Long 1554347313

最后一次异地备份同步时间。UNIX时间,单位为秒。

Replication Boolean false

是否为异地备份仓库。

  • true表示为异地备份仓库。
  • false表示本地备份仓库。
ReplicationSourceRegionId String v-*********************

异地备份仓库所属的地域ID。

ReplicationSourceVaultId String v-*********************

异地备份仓库源仓库ID。

ResourceGroupId String rg-*********************

资源组ID。

Status String CREATED

备份仓库状态。

  • UNKNOWN:未知
  • INITIALIZING:初始化中
  • CREATED:已创建
  • ERROR:错误
StorageSize Long 10

备份库使用量。单位为Byte。

Tags Array of Tag

备份仓库的标签信息。

Tag
Key String aaa

仓库的标签键。N的取值范围:1~20。

  • 不支持以aliyunacs:开头。
  • 不允许包含http://https://
  • 不允许为空字符串。
Value String a1

仓库的标签值。N的取值范围:1~20。

  • 不支持以aliyunacs:开头。
  • 不允许包含http://https://
  • 不允许为空字符串。
UpdatedTime Long 1554347313

备份仓库更新时间。UNIX时间,单位为秒。

VaultId String v-*********************

备份仓库ID。

VaultName String vaultname

备份仓库名称。

VaultRegionId String cn-shanghai

备份仓库所属的地域ID。

VaultStatusMessage String SOURCE_VAULT_ALREADY_HAS_REPLICATION

(仅异地备份仓库有效) 仓库错误状态信息,取值范围:

  • UNKNOWN_ERROR表示未知错误。
  • SOURCE_VAULT_ALREADY_HAS_REPLICATION 表示复制源仓库已经设置了其他镜像仓库。
VaultStorageClass String STANDARD

备份仓库存储类型。取值仅为STANDARD,表示标准存储。

VaultType String STANDARD

备份仓库类型。取值仅为STANDARD,表示普通仓库。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeVaults
&<公共请求参数>

正常返回示例

XML格式

<DescribeVaultsResponse>
  <TotalCount>8</TotalCount>
  <PageSize>10</PageSize>
  <Message>successful</Message>
  <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
  <PageNumber>1</PageNumber>
  <Code>200</Code>
  <Success>true</Success>
  <Vaults>
        <Vault>
              <Status>CREATED</Status>
              <Description>vault description</Description>
              <CreatedTime>1554347313</CreatedTime>
              <ResourceGroupId>rg-*********************</ResourceGroupId>
              <VaultName>vaultname</VaultName>
              <VaultStorageClass>STANDARD</VaultStorageClass>
              <ReplicationSourceRegionId>v-*********************</ReplicationSourceRegionId>
              <StorageSize>10</StorageSize>
              <ReplicationSourceVaultId>v-*********************</ReplicationSourceVaultId>
              <VaultId>v-*********************</VaultId>
              <VaultRegionId>cn-shanghai</VaultRegionId>
              <VaultType>STANDARD</VaultType>
              <VaultStatusMessage>SOURCE_VAULT_ALREADY_HAS_REPLICATION</VaultStatusMessage>
              <LatestReplicationTime>1554347313</LatestReplicationTime>
              <Replication>false</Replication>
              <BytesDone>20</BytesDone>
              <UpdatedTime>1554347313</UpdatedTime>
              <Tags>
                    <Tag>
                          <Value>a1</Value>
                          <Key>aaa</Key>
                    </Tag>
              </Tags>
        </Vault>
  </Vaults>
</DescribeVaultsResponse>

JSON格式

{
    "TotalCount": 8,
    "PageSize": 10,
    "Message": "successful",
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "PageNumber": 1,
    "Code": 200,
    "Success": true,
    "Vaults": {
        "Vault": {
            "Status": "CREATED",
            "Description": "vault description",
            "CreatedTime": 1554347313,
            "ResourceGroupId": "rg-*********************",
            "VaultName": "vaultname",
            "VaultStorageClass": "STANDARD",
            "ReplicationSourceRegionId": "v-*********************",
            "StorageSize": 10,
            "ReplicationSourceVaultId": "v-*********************",
            "VaultId": "v-*********************",
            "VaultRegionId": "cn-shanghai",
            "VaultType": "STANDARD",
            "VaultStatusMessage": "SOURCE_VAULT_ALREADY_HAS_REPLICATION",
            "LatestReplicationTime": 1554347313,
            "Replication": false,
            "BytesDone": 20,
            "UpdatedTime": 1554347313,
            "Tags": {
                "Tag": {
                    "Value": "a1",
                    "Key": "aaa"
                }
            }
        }
    }
}

错误码

访问错误中心查看更多错误码。