更新时间:2024-03-27 GMT+08:00

查询资源实例数量

功能介绍

查询资源实例数量。

URI

POST /v5/{project_id}/{resource_type}/resource-instances/count

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

resource_type

String

资源类型。

  • migration:实时迁移
  • sync:实时同步
  • cloudDataGuard:实时灾备
  • subscription:数据订阅
  • backupMigration:备份迁移
  • replay:录制回放

枚举值:

  • migration
  • sync
  • cloudDataGuard
  • subscription
  • backupMigration
  • replay

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。用户Token也就是调用IAM获取用户Token接口的响应值,请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。

缺省值:en-us

枚举值:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

Boolean

不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”字段。该字段为false或者未提供该参数时,该条件不生效,即返回所有资源或按"tags","matches"等条件过滤。

tags

Array of objects

包含标签,最多包含20个key,每个key下面的value最多20个。

详情请参见表4

matches

Array of objects

搜索字段,key为要匹配的字段,如resource_name等。value为匹配的值。

详情请参见表5

表4 tags字段数据结构说明

参数

是否必选

参数类型

描述

key

String

标签键。

values

Array of strings

标签值。

表5 matches字段数据结构说明

参数

是否必选

参数类型

描述

key

String

键。

value

String

值。

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

total_count

Integer

总数。

请求示例

查询同步任务资源实例数量。

 https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/sync/resource-instances/count

{
  "tags" : [ {
    "key" : "key1",
    "values" : [ "value1", "value2" ]
  }, {
    "key" : "key2",
    "values" : [ "value1", "value2" ]
  } ],
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ],
  "without_any_tag" : false
}

响应示例

状态码: 200

OK

{
  "total_count" : 1
}

状态码

状态码

描述

200

OK

错误码

请参见错误码