查询可应用实例列表 - QueryingInstancesThataParameterTemplateCanBeAppliedTo
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/configurations/{config_id}/applicable-instances
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| config_id | 是 | String | 参数解释: 参数模板ID。 请参考获取参数模板列表 - ObtainingParameterTemplates获取参数模板ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 |
| offset | 否 | Integer | 参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,例如:该参数指定为0,limit指定为10,则只展示第1~10条数据。 约束限制: 不涉及。 取值范围: [0, 2147483647]。 默认取值: 默认为0(偏移0条数据,表示从第一条数据开始查询)。 |
| limit | 否 | Integer | 参数解释: 查询记录数。例如该参数设定为10,则查询结果最多只显示10条记录。 约束限制: 不涉及。 取值范围: [1, 100] 默认取值: 100 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Language | 否 | String | 参数解释: 指定接口返回信息的语言类型。 约束限制: 不涉及。 取值范围:
默认取值: en-us |
响应参数
| 参数 | 参数类型 | 描述 |
|---|---|---|
| instances | Array of objects | 参数解释: 可应用参数模板的实例信息,具体参数请参考表4。 |
| total_count | Integer | 参数解释: 可应用参数组模板的实例总数。 取值范围: 不涉及。 |
请求示例
查询可应用当前参数组模板的实例列表。
GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/applicable-instances
响应示例
查询可应用当前参数组模板的实例列表成功。
{
"instances": [
{
"instance_id": "1995a67680474481b3e42ac1474e32e0in14",
"instance_name": "gauss-a283"
},
{
"instance_id": "8303819fd8744ef69f34595e9710a33din14",
"instance_name": "gauss-2423-lt-master"
}
],
"total_count": 2
} 状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。