
# 查询参数模板可应用的实例列表 - QueryingInstancesthataParameterTemplateCanBeAppliedTo
#### 功能介绍
查询参数模板可应用的实例列表。
#### 接口约束
该接口支持如下数据库实例：
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
 
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GaussDBforNoSQL/doc?api=ShowApplicableInstances)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                           | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名                | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:list | Read | -           | -   | nosql:backup:list | -      |
     
  
 
#### URI
GET /v3/{project_id}/configurations/{config_id}/applicable-instances
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 |
| config_id  | 是    | String | **参数解释：** 参数模板id。获取方法请参见[获取参数模板列表 - ObtainingParameterTemplates](https://support.huaweicloud.com/api-nosql/nosql_06_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                                |
   
表2Query参数 
| 参数            | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|:---|:---|:---|:---|
| offset        | 否    | Integer | **参数解释：** 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询。 **约束限制：** 不涉及。 **取值范围：** 大于等于0。 **默认取值：** 默认为0（偏移0条数据，表示从第一条数据开始查询）。                        |
| limit         | 否    | Integer | **参数解释：** 查询个数上限值。 **约束限制：** 不涉及。 **取值范围：** 1\~100。 **默认取值：** 不传该参数时，默认查询前100条信息。                                                                                                 |
| instance_name | 否    | String  | **参数解释：** 实例名称，支持模糊搜索。 **约束限制：** 不涉及。 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                  |
| instance_id   | 否    | String  | **参数解释：** 实例id，支持模糊搜索。可以调用[查询实例列表和详情 - QueryingInstancesandDetails](https://support.huaweicloud.com/api-nosql/nosql_05_0016.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数        | 参数类型                                                                                                | 描述                                                                                                                                                                                                                                 |
|:---|:---|:---|
| instances | Array of [ApplicableInstanceRsp] objects | **参数解释：** 实例列表。                                                                                                                                                                         |
| count     | Integer                                                                                             | **参数解释：** 可应用该参数模板的实例总数。 **取值范围：** 不涉及。 |
   
 表5ApplicableInstanceRsp 
| 参数   | 参数类型   | 描述                                                                                                                                                               |
|:---|:---|:---|
| id   | String | **参数解释：** 实例ID。 **取值范围：** 不涉及。 |
| name | String | **参数解释：** 实例名称。 **取值范围：** 不涉及。      |
   
#### 请求示例
URI样例
```
GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/9e80bf6bbd7142f49761c07e9c32dd04pr06/applicable-instances?offset=0&limit=10
```
#### 响应示例
**状态码： 200**
Success
```
{
  "instances" : [ {
    "id" : "f38e203908bd4fae82714e88f12600f6in06",
    "name" : "test"
  } ],
  "count" : 1000
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。
