
# 通过标签查询资源实例列表 - ListResourcesByTag
#### 功能介绍
通过标签查询资源实例列表。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-ga/ga_03_0000.html)。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ga/ga_06_0000.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                    | 访问级别 | 资源类型（\*为必须） | 条件键       | 别名                          | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | ga::listResourcesByTag | List | -           | g:TagKeys | - ga:tag:listResourcesByTag | -      |
     
#### URI
POST /v1/{resource_type}/resource-instances/filter
表1路径参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                   |
|:---|:---|:---|:---|
| resource_type | 是    | Object | 资源类型，取值范围： - ga-accelerators：加速实例 - ga-listeners：监听器 |
表2Query参数 
| 参数     | 是否必选 | 参数类型    | 描述       |
|:---|:---|:---|:---|
| limit  | 否    | Integer | 每页返回的个数。 |
| offset | 否    | Integer | 偏移量。     |
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                       |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
表4请求Body参数 
| 参数      | 是否必选 | 参数类型                                                         | 描述     |
|:---|:---|:---|:---|
| tags    | 否    | Array of [Tag] objects     | 标签列表。  |
| matches | 否    | Array of [Match] objects | 匹配项列表。 |
   
 表5Tag 
| 参数     | 是否必选 | 参数类型             | 描述        |
|:---|:---|:---|:---|
| key    | 是    | String           | 匹配的标签键。   |
| values | 是    | Array of strings | 匹配的标签值列表。 |
   
 表6Match 
| 参数    | 是否必选 | 参数类型   | 描述                                        |
|:---|:---|:---|:---|
| key   | 是    | String | 匹配资源实例的属性类型。 取值范围： resource_name：通过资源名称匹配 |
| value | 是    | String | 匹配资源实例的属性值。                               |
   
#### 响应参数
**状态码：200**
表7响应Body参数 
| 参数          | 参数类型                                                                        | 描述     |
|:---|:---|:---|
| resources   | Array of [ResourceTags] objects | 资源列表。  |
| total_count | Integer                                                                     | 资源总数量。 |
   
 表8ResourceTags 
| 参数            | 参数类型                                                                      | 描述    |
|:---|:---|:---|
| resource_id   | String                                                                    | 资源ID。 |
| resource_name | String                                                                    | 资源名称。 |
| tags          | Array of [ResourceTag] objects | 标签。   |
   
 表9ResourceTag 
| 参数    | 参数类型   | 描述                                                                                                                          |
|:---|:---|:---|
| key   | String | 标签键，取值范围： - key不能为空，长度1\~128个字符（中文也可以输入128个字符）。 - 可用 UTF-8 格式表示的字母（包含中文）、数字和空格，以及以下字符_ . : = + - @。 - _sys_开头属于系统标签，租户不能输入。 |
| value | String | 标签值，取值范围： - 长度0\~255个字符（中文也可以输入255个字符）。 - 可用 UTF-8 格式表示的字母（包含中文）、数字和空格，以及以下字符_ . : / = + - @。 - 资源标签值可以为空（empty or null）。   |
   
#### 请求示例
通过标签查询资源实例列表
```
POST https://{ga_endpoint}/v1/{resource_type}/resource-instances/filter
{
  "tags" : [ {
    "key" : "tagKey",
    "values" : [ "tagValue" ]
  } ],
  "matches" : [ {
    "key" : "resourceName",
    "value" : "name"
  } ]
}
```
#### 响应示例
**状态码：200**
操作成功
```
{
  "resources" : [ {
    "resource_id" : "c2b210b2-60c4-449d-91e2-9e9ea1dd7443",
    "resource_name" : "resourceName",
    "tags" : [ {
      "key" : "tagKey",
      "value" : "tagValue"
    } ]
  } ],
  "total_count" : 1
}
```
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 200 | 操作成功 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ga/ErrorCode.html)。
