查询安全组资源实例

功能介绍

使用标签过滤实例

URI

POST /v2.0/{project_id}/security-groups/resource_instances/action

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
action	是	String	功能说明：操作标识取值范围：filter(过滤)，count(查询总条数)
limit	否	Integer	功能说明：查询记录数取值范围：1-1000 约束：action为count时此参数不生效；action为filter时默认为1000
offset	否	Integer	功能说明：索引位置，从offset指定的下一条数据开始查询。查询第一页数据时，不需要传入此参数，查询后续页码数据时，将查询前一页数据时响应体中的值带入此参数约束：action为count时无此参数；action为filter时默认为0；必须为数字，不能为负数
matches	否	Array of Match objects	功能说明：搜索字段，key为要匹配的字段，value为匹配的值约束：当前仅支持resource_name
tags	否	Array of ListTag objects	包含标签，最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复

表3 Match
参数	是否必选	参数类型	描述
key	是	String	键。当前仅限定为resource_name
value	是	String	值。每个值最大长度255个unicode字符，不能包含$ - . /等特殊字符。最大长度：255

表4 ListTag
参数	是否必选	参数类型	描述
key	是	String	功能说明：标签键约束：key不能为空最小长度：1 最大长度：127
values	是	Array of strings	功能描述：标签值列表。如果values为空列表，则表示any_value。value之间为或的关系。

响应参数

状态码： 200

表5 响应Body参数
参数	参数类型	描述
resources	Array of ListResourceResp objects	资源列表
total_count	Integer	资源数量

表6 ListResourceResp
参数	参数类型	描述
resource_detail	Object	资源详情。资源对象，用于扩展。默认为空
resource_id	String	资源ID
resource_name	String	资源名称，没有默认为空字符串
tags	Array of ResourceTag objects	标签列表，没有标签默认为空数组

表7 ResourceTag
参数	参数类型	描述
key	String	功能说明：标签键约束：同一资源的key值不能重复。最小长度：0 最大长度：36
value	String	功能说明：标签值最小长度：0 最大长度：43

状态码： 400

表8 响应Body参数
参数	参数类型	描述
code	String	请求返回的错误码
message	String	请求返回的错误信息最小长度：1 最大长度：999

状态码： 401

表9 响应Body参数
参数	参数类型	描述
code	String	请求返回的错误码
message	String	请求返回的错误信息最小长度：1 最大长度：999

状态码： 403

**表10** 响应Body参数
参数	参数类型	描述
code	String	请求返回的错误码
message	String	请求返回的错误信息最小长度：1 最大长度：999

状态码： 404

**表11** 响应Body参数
参数	参数类型	描述
code	String	请求返回的错误码
message	String	请求返回的错误信息最小长度：1 最大长度：999

状态码： 409

**表12** 响应Body参数
参数	参数类型	描述
code	String	请求返回的错误码
message	String	请求返回的错误信息最小长度：1 最大长度：999

状态码： 500

**表13** 响应Body参数
参数	参数类型	描述
code	String	请求返回的错误码
message	String	请求返回的错误信息最小长度：1 最大长度：999

请求示例

查询安全组资源实例，action为filter时请求体。

POST https://{Endpoint}/v2.0/{project_id}/security-groups/resource_instances/action

{
  "offset" : "0",
  "limit" : "100",
  "action" : "filter",
  "matches" : [ {
    "key" : "resource_name",
    "value" : "resource1"
  } ],
  "tags" : [ {
    "key" : "key1",
    "values" : [ "*value1", "value2" ]
  } ]
}

example-2：action为count时请求体

POST https://{Endpoint}/v2.0/{project_id}/security-groups/resource_instances/action

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

响应示例

状态码： 200

请求体action为filter时返回资源tag列表，action为count时返回tag总数

{
  "resources" : [ {
    "resource_id" : "cdfs_cefs_wesas_12_dsad",
    "resource_name" : "resouece1",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    }, {
      "key" : "key2",
      "value" : "value1"
    } ]
  } ],
  "total_count" : 1000
}

状态码

状态码	描述
200	请求体action为filter时返回资源tag列表，action为count时返回tag总数
400	服务器未能处理请求。
401	被请求的页面需要用户名和密码。
403	对被请求页面的访问被禁止。
404	服务器无法找到被请求的页面。
409	由于冲突，请求无法被完成。
500	请求未完成。服务异常。