文档首页/ 云手机服务器 CPH/ API参考/ 云手机服务器API/ 标签管理/ 查询资源实例
更新时间：2024-08-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询资源实例

功能介绍

查询资源实例。

调试

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

URI

POST /v1/{project_id}/{resource_type}/resource_instances/action

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id。

resource_type

是

String

资源类型。

  • cph-server，云手机服务器

枚举值：

  • cph-server

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

action

是

String

操作标识（仅限于filter，count）：filter（过滤），count(查询总条数)。 为filter时表示分页查询，为count只需按照条件将总条数返回即可。

枚举值：

  • filter

  • count

offset

否

String

索引位置， 从offset指定的下一条数据开始查询。 查询第一页数据时，不需要传入此参数，查询后续页码数据时，将查询前一页数据时响应体中的值带入此参数。action为count时无此参数。action为filter时，默认为0，必须为数字，且不能为负数。

limit

否

String

查询记录数。

action为count时无此参数。

action为filter时，默认为1000。limit最多为1000，不能为负数，最小值为1。

without_any_tag

否

Boolean

不包含任意一个标签，该字段为true时查询所有不带标签的资源。

tags

否

Array of Tags objects

最多包含10个key，每个key最多包含10个value，结构体不能缺失。key不能为空或者空字符串。key不能重复，同一个key中value不能重复，不同key对应的资源之间为与的关系。

matches

否

Array of Match objects

搜索字段。

key为要匹配的字段，当前只支持resource_name。

value为匹配的值，当前为精确匹配。
表4 Tags

参数

是否必选

参数类型

描述

key

是

String

键。

  • 最大长度127个unicode字符。

  • key不能为空。

values

是

Array of strings

值列表。

  • 最多10个value。

  • value不允许重复。

  • 每个值最大长度255个unicode字符。

  • 如果values为空则表示any_value。

  • value之间为或的关系。
表5 Match

参数

是否必选

参数类型

描述

key

是

String

键。

当前key的参数值只能取“resource_name”，此时value的参数值为资源名称。

枚举值：

  • resource_name

value

是

String

值。

当前key的参数值只能取“resource_name”，此时value的参数值为资源名称。

响应参数

状态码： 200

表6 响应Body参数

参数

参数类型

描述

resources

Array of Resource objects

资源列表。

total_count

Integer

资源总数。
表7 Resource

参数

参数类型

描述

resource_id

String

资源ID。

resource_detail

String

资源详情。

resource_name

String

资源名称。

tags

Array of Tag objects

标签列表。
表8 Tag

参数

参数类型

描述

key

String

键。

  • 最大长度127个unicode字符。

  • 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，不能以_sys_开头。

value

String

值列表。

  • 每个值最大长度255个unicode字符。

  • 不能为空，可以包含任意语种字母、数字、空格和_.：=+-@，但首尾不能含有空格。

请求示例

  • 查询资源实例数量

    Post https://{CPH Endpoint}/v1/{project_id}/{resource_type}/resource_instances/action

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

  • 查询资源实例列表

    Post https://{CPH Endpoint}/v1/{project_id}/{resource_type}/resource_instances/action

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

响应示例

状态码： 200

ok

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

状态码

状态码

描述

200

ok

错误码

请参见错误码。

父主题： 标签管理

相关文档