华为云计算 云知识 查询资源实例ListResourceByFilterTag
查询资源实例ListResourceByFilterTag

 

功能介绍

查询资源实例

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v3/{domain_id}/ccaas/{resource_type}/resource-instances/action

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

帐号ID。

最小长度:10

最大长度:32

resource_type

String

资源类型:

  • cloud-connection: 云连接

  • bandwidth-package: 带宽包

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token

最小长度:0

最大长度:102400

表3 请求Body参数

参数

是否必选

参数类型

描述

action

String

动作。|- filter:过滤。 count:查询总条数。

limit

Integer

查询结果数量限制

最小值:1

最大值:1000

offset

Integer

查询结果偏移

最小值:0

最大值:999

tags

Array of AggTag objects

是否包含以下tag(多个key取"与"关系,多个value取"或"关系)

matches

Array of Tag objects

是否匹配以下tag,key必须为"resource_name",value如果有值则模糊匹配,如果为空字符串则精确匹配

表4 AggTag

参数

是否必选

参数类型

描述

key

String

最小长度:1

最大长度:128

values

Array of strings

相同键的值列表

最小长度:0

最大长度:255

表5 Tag

参数

是否必选

参数类型

描述

key

String

最小长度:1

最大长度:128

value

String

最小长度:0

最大长度:255

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

resources

Array of FilterTagResource objects

资源实例实例列表。

request_id

String

请求ID。

最小长度:0

最大长度:36

total_count

Integer

符合过滤条件的资源总数量。

最小值:0

最大值:2000

表7 FilterTagResource

参数

参数类型

描述

resource_id

String

资源ID

最小长度:0

最大长度:36

resource_name

String

资源名称

最小长度:0

最大长度:64

resource_detail

String

资源详情

最小长度:0

最大长度:255

tags

Array of Tag objects

资源下包含的标签

表8 Tag

参数

参数类型

描述

key

String

最小长度:1

最大长度:128

value

String

最小长度:0

最大长度:255

请求示例

  • 根据指定筛选条件查询资源例详情

    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

错误码

请参见错误码

 

上一篇:无纸化办公的优点 下一篇:WebBench有什么作用

弹性云服务器 ECS

 

弹性云服务器(Elastic Cloud Server)是一种可随时自助获取、可弹性伸缩的云服务器,帮助用户打造可靠、安全、灵活、高效的应用环境,确保服务持久稳定运行,提升运维效率