文档首页> 云数据库 GaussDB> API参考> API（推荐）> 参数配置> 查询可应用实例列表
更新时间：2024-05-21 GMT+08:00
查看PDF

查询可应用实例列表

功能介绍

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

URI

GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applicable-instances

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的项目ID。

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

config_id

是

String

参数模板ID。

offset

否

Integer

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。例如：该参数指定为0，limit指定为10，则只展示第1~10条数据。

limit

否

Integer

查询记录数。默认为100，不能为负数，最小值为1，最大值为100。例如该参数设定为10，则查询结果最多只显示10条记录。

请求参数

无。

响应参数

表2 参数说明

参数

参数类型

描述

instances

Array of objects

参数模板信息，具体参数请参考表3。

total_count

Integer

总记录数。
表3 instances字段数据结构说明

参数

参数类型

描述

instance_id

String

实例ID。

instance_name

String

实例名称。

请求示例

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

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/applicable-instances

响应示例

查询可应用当前参数组模板的实例列表成功。

{
    "total_count": 2,
    "instances": [
        {
            "instance_id": "1995a67680474481b3e42ac1474e32e0in14",
            "instance_name": "gauss-a283"
        },
        {
            "instance_id": "8303819fd8744ef69f34595e9710a33din14",
            "instance_name": "gauss-2423-lt-master"
        }
	]
}

状态码

错误码

请参见错误码。

父主题： 参数配置