功能介绍
查询资源实例
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v3/{domain_id}/ccaas/{resource_type}/resource-instances/action
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
帐号ID。 最小长度:10 最大长度:32 |
resource_type |
是 |
String |
资源类型:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token 最小长度:0 最大长度:102400 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
action |
否 |
String |
动作。|- filter:过滤。 count:查询总条数。 |
limit |
否 |
Integer |
查询结果数量限制 最小值:1 最大值:1000 |
offset |
否 |
Integer |
查询结果偏移 最小值:0 最大值:999 |
tags |
否 |
是否包含以下tag(多个key取"与"关系,多个value取"或"关系) |
|
matches |
否 |
是否匹配以下tag,key必须为"resource_name",value如果有值则模糊匹配,如果为空字符串则精确匹配 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
resources |
资源实例实例列表。 |
|
request_id |
String |
请求ID。 最小长度:0 最大长度:36 |
total_count |
Integer |
符合过滤条件的资源总数量。 最小值:0 最大值:2000 |
请求示例
-
根据指定筛选条件查询资源例详情
POST https://{cc_endpoint}/v3/{domain_id}/ccaas/{resource_type}/resource-instances/action { "offset" : "0", "limit" : "100", "action" : "filter", "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ] }
-
根据指定筛选条件查询资源实例数量
POST https://{cc_endpoint}/v3/{domain_id}/ccaas/cloud-connection/resource-instances/action { "action" : "count", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] }, { "key" : "key2", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" } ] }
响应示例
状态码: 200
查询资源实例成功
{ "resources" : [ { "resource_detail" : null, "resource_id" : "cdfs_cefs_wesas_12_dsad", "resource_name" : "resouece1", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value1" } ] } ], "request_id" : "XXX", "total_count" : 1000 }
状态码
状态码 |
描述 |
---|---|
200 |
查询资源实例成功 |
400 |
Invalid demoId value |
错误码
请参见错误码。