文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 参数模板管理/ 查询参数模板可应用的实例列表
更新时间:2023-11-21 GMT+08:00

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

功能介绍

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

接口约束

该接口支持如下数据库实例:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一region下的project ID。获取方法请参见获取项目ID

config_id

String

参数模板id

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

索引位置,偏移量。

从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。

取值必须为数字,不能为负数。

limit

Integer

查询个数上限值。

  • 取值范围: 1~100。
  • 不传该参数时,默认查询前100条信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

instances

Array of ApplicableInstanceRsp objects

实例列表。

count

Integer

应用参数的实例数量限制。

表5 ApplicableInstanceRsp

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

请求示例

  • URI样例
    GET https://gaussdb-nosql.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/9e80bf6bbd7142f49761c07e9c32dd04pr06/applicable-instances?offset=0&limit=10  

响应示例

状态码: 200

Success

{
  "instances" : [ {
    "id" : "f38e203908bd4fae82714e88f12600f6in06",
    "name" : "test"
  } ],
  "count" : 1000
}

状态码

请参见状态码

错误码

请参见错误码