文档首页> 云数据库 GaussDB(for MySQL)> API参考> API（推荐）> 参数模板管理> 查询可应用的实例列表
更新时间：2023-10-23 GMT+08:00
在线调试
CLI示例
查看PDF

查询可应用的实例列表

功能介绍

查询指定参数模板可被应用的实例。

URI

GET /v3/{project_id}/configurations/{configuration_id}/applicable-instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

configuration_id

是

String

参数模板ID。

通过调用查询参数模板接口获取。

请求响应成功后在响应消息体中包含的“id”的值即为configuration_id值。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

limit

否

Integer

查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。默认en-us。

取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

instances

Array of ApplicableInstances objects

可以应用的实例列表。

total_count

Integer

可应用的实例列表数量。
表5 ApplicableInstances

参数

参数类型

描述

instance_id

String

实例ID。

instance_name

String

实例名称。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询可应用该模板参数组的实例列表。

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/0c82974e2354466098d7b4b72e55129dpr07/applicable-instances

响应示例

状态码： 200

Success.

{
  "total_count" : 10,
  "instances" : [ {
    "instance_id" : "75e1935142974ca685357dc784626f22in07",
    "instance_name" : "gauss-ff14-hll"
  }, {
    "instance_id" : "cf72c31a689c40b7883c355a0bb5cc1din07",
    "instance_name" : "tst-bbbnew"
  }, {
    "instance_id" : "4a99fbae95df43648281cdd9e269c1c7in07",
    "instance_name" : "gauss-62d8"
  }, {
    "instance_id" : "fb6244dc9b1443b7ad0aae81283d5d28in07",
    "instance_name" : "gauss-test-1"
  }, {
    "instance_id" : "2260da7e105e485ebc9c060c1663d89ain07",
    "instance_name" : "gauss-f4c6-cx"
  }, {
    "instance_id" : "1cf7357f931448f89229de664c114d05in07",
    "instance_name" : "gauss-wry-0710-3"
  }, {
    "instance_id" : "5280b1a667d142378fe28816afb2e4b8in07",
    "instance_name" : "taurus_WAkJSzVy"
  }, {
    "instance_id" : "56c6924923804259a1b15b846c6b4bf1in07",
    "instance_name" : "tck-update3"
  }, {
    "instance_id" : "72a8f4287e04427985087795825fcddain07",
    "instance_name" : "critBack"
  }, {
    "instance_id" : "c5df1dec75ed48ab85fe52c72ba784bbin07",
    "instance_name" : "gauss-f873-cx"
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 参数模板管理