查询账户全域互联带宽资源实例列表
功能介绍
查询账户全域互联带宽资源实例列表
调用方法
请参见如何调用API。
URI
POST /v3/gcb/resource-instances/filter
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
查询记录数。 最小值:1 最大值:1000.0 |
offset |
否 |
Integer |
索引位置,偏移量。 最小值:0 最大值:999 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 最小长度:0 最大长度:102400 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
request_id |
否 |
String |
请求ID。 最小长度:0 最大长度:36 |
without_any_tag |
否 |
Boolean |
不包含任意一个标签,该字段为true时查询所有不带标签的资源,此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 |
tags |
否 |
Array of QueryTag objects |
包含标签,最多包含20个key,每个key下面的value最多10个,每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回包含所有标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 数组长度:0 - 50 |
tags_any |
否 |
Array of QueryTag objects |
包含任意标签,最多包含20个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回包含标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。 数组长度:0 - 50 |
not_tags |
否 |
Array of QueryTag objects |
不包含标签,最多包含20个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回不包含标签的资源列表,key之间是与的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。 数组长度:0 - 50 |
not_tags_any |
否 |
Array of QueryTag objects |
不包含任意标签,最多包含20个key,每个key下面的value最多10个, 每个key对应的value可以为空数组但结构体不能缺失。Key不能重复,同一个key中values不能重复。结果返回不包含标签的资源列表,key之间是或的关系,key-value结构中value是或的关系。无过滤条件时返回全量数据。 数组长度:0 - 50 |
matches |
否 |
Array of TmsMatch objects |
是否匹配以下tag,key必须为"resource_name",value如果有值则模糊匹配,如果为空字符串则精确匹配。 数组长度:0 - 50 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
resources |
Array of TmsResource objects |
数组长度:0 - 2000 |
total_count |
Integer |
总记录数。 最小值:0 最大值:2000.0 |
request_id |
String |
Request ID 最小长度:0 最大长度:36 |
参数 |
参数类型 |
描述 |
---|---|---|
resource_id |
String |
资源ID。 最小长度:1 最大长度:36 |
tags |
Array of Tag objects |
标签列表,没有标签默认为空数组。 数组长度:0 - 20 |
resource_name |
String |
资源名称,资源没有名称时默认为空字符串。 最小长度:1 最大长度:64 |
请求示例
查询账户全域互联带宽资源实例列表
POST https://{cc_endpoint}/v3/gcb/resource-instances/filter { "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }
响应示例
状态码: 200
查询账户全域互联带宽资源实例列表。
{ "resources" : [ { "resource_id" : "cb9d7ead-834a-4275-93e1-217f79df9dc1", "resource_name" : "test", "tags" : [ { "key" : "key1", "value" : "value1" } ] } ], "request_id" : "e3371202-7e85-4c16-bb4b-4e3c092734f7", "total_count" : 1 }
状态码
状态码 |
描述 |
---|---|
200 |
查询账户全域互联带宽资源实例列表。 |
错误码
请参见错误码。