Help Center/ GeminiDB/ API Reference/ APIs v3 (Recommended)/ Parameter Configuration/ Querying Instances that a Parameter Template Can Be Applied To
Updated on 2025-12-04 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 instances:

  • GeminiDB Cassandra
  • GeminiDB Mongo
  • GeminiDB Influx
  • GeminiDB Redis

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    gaussdbfornosql:instance:list

    Read

    -

    -

    nosql:backup:list

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

config_id

Yes

String

Definition

Parameter template ID

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Index offset.

The query starts from the next piece of data indexed by this parameter.

Constraints

N/A

Range

The value must be a non-negative number.

Default Value

The default value is 0, indicating that the query starts from the first data record.

limit

No

Integer

Definition

Maximum records to be queried

Constraints

N/A

Range

1 to 100

Default Value

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

instance_name

No

String

Definition

Instance name. Fuzzy search is supported.

Constraints

N/A

Range

N/A

Default Value

N/A

instance_id

No

String

Definition

Instance ID. Fuzzy search is supported.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

instances

Array of ApplicableInstanceRsp objects

Definition

Instance list

Range

N/A

count

Integer

Definition

Maximum number of instances that the parameter can be applied to

Range

N/A
Table 5 ApplicableInstanceRsp

Parameter

Type

Description

id

String

Definition

Instance ID

Range

N/A

name

String

Definition

Instance name

Range

N/A

Example Requests

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

Example Responses

Status code: 200

Successful response

{
  "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