Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Parameter Configuration/ Querying Instances that a Parameter Template Can Be Applied To
Updated on 2025-09-16 GMT+08:00
View PDF
Share

Querying Instances that a Parameter Template Can Be Applied To

Function

This API is used to query instances that a parameter template can be applied to.

Constraints

This API supports the following instance types:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx instance with classic storage
  • GeminiDB Redis instance with classic storage

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Values:

N/A

Default value:

N/A

config_id

Yes

String

Explanation:

Parameter template ID

Constraints:

N/A

Values:

N/A

Default value:

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Explanation:

Index offset.

Constraints:

The value can contain only digits.

Values:

The value cannot be a negative number.

Default value:

If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data.

limit

No

Integer

Explanation:

Maximum records to be queried

Constraints:

N/A

Values:

1 to 100

Default value:

If this parameter is not transferred, the first 100 records are queried by default.

Request Parameters

Table 3 Request header parameter

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Explanation:

User token

Constraints:

N/A

Values:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

instances

Array of ApplicableInstanceRsp objects

Explanation:

Instance list

Values:

N/A

count

Integer

Explanation:

Maximum number of instances that the parameter can be applied to

Values:

N/A
Table 5 ApplicableInstanceRsp

Parameter

Type

Description

id

String

Explanation:

Instance ID

Values:

N/A

name

String

Explanation:

Instance name

Values:

N/A

Example Request

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

Example Response

Status code: 200

Successful request

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

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: Parameter Configuration