通过标签查询云硬盘资源实例个数

功能介绍

通过标签查询云硬盘资源实例个数。

接口约束

无

URI

• URI格式

  POST /v2/{project_id}/os-vendor-volumes/resource_instances/action

• 参数说明

  参数	是否必选	描述
  project_id	是	项目ID。 获取方法请参见获取项目ID。

请求消息

• 请求参数

  参数	参数类型	是否必选	描述
  tags	Array of objects	否	标签的键值对，请参见•resource_tag参数数据结构说明。 标签列表中不允许为空列表。 标签列表中最多包含10个key 。 标签列表中的标签key值不允许重复。 标签列表中多个key之间是“与”的关系，云硬盘必须满足请求中所有key才会匹配出来。 说明： 如果存在多个tags结构体，以最后一个tags结构体为准，之前的会被覆盖。
  action	String	是	操作标识。 根据标签查询云硬盘实例个数时使用“count”。
  matches	Array of objects	否	资源本身支持的查询条件，请参见•match参数数据结构说明。 标签列表中不允许为空列表。 标签列表中的标签key值不允许重复。

• resource_tag参数数据结构说明

  参数	参数类型	是否必选	描述
  key	String	是	标签键。同一资源的key值不能重复。 最大长度36个字符。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。
  values	Array of objects	是	标签列表中最多包含10个value。 标签列表中的标签value值不允许重复。 标签列表如果为空列表，表示匹配任意值。 标签列表中多个value之间是“或”的关系，在key已经满足要求的前提下，云硬盘满足请求中的某个value就会匹配出来。

• match参数数据结构说明

  参数	参数类型	是否必选	描述
  key	String	是	键。枚举值。 key取值范围为： resource_name：资源名称。 service_type：服务类型。
  value	String	是	值。 最大长度255个UNICODE字符。 value为空字符串时精确匹配，为非空字符串时模糊匹配。 key为“resource_name”时，value前后的空格会被丢弃。

• 请求样例

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

响应消息

• 响应参数

  参数	参数类型	描述
  total_count	Integer	符合查询条件的云硬盘资源个数
  error	Object	出现错误时，返回的错误信息，具体请参见•error参数说明。

• error参数说明

  参数	参数类型	描述
  message	String	出现错误时，返回的错误消息。
  code	String	出现错误时，返回的错误码。 错误码和其对应的含义请参考错误码。

• 响应样例

  {
      "total_count": 1000
  }

  或

  {
      "error": {
          "message": "XXXX", 
          "code": "XXX"
      }
  }

  其中error是泛指的错误，有badRequest、itemNotFound等，如报错：

  {
      "computeFault": {
          "message": "The server has either erred or is incapable of performing the requested operation.", 
          "code": 500
      }
  }

状态码

• 正常

  200

错误码

请参考错误码。