Help Center/ GeminiDB/ API Reference/ API v3/ Instances/ Querying the Password-Free Configuration of a GeminiDB Redis Instance
Updated on 2026-09-22 GMT+08:00

Querying the Password-Free Configuration of a GeminiDB Redis Instance

Function

This API is used to query the password-free configuration of a GeminiDB Redis instance.

Constraints

This API supports the following instance:

  • 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:getPasswordlessConfig

    Read

    instance *

    -

    nosql:instance:getPasswordlessConfig

    -

URI

GET /v3/{project_id}/instances/{instance_id}/passwordless-config

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

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID. To obtain the value, call the Querying Instances and Details API. If no instance is available, call the Creating an Instance API to create one.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Index position. If offset is set to N, the password-free configuration query starts from the N+1 piece of data.

Constraints

N/A

Range

≥ 0

Default Value

If this parameter is not transferred, offset is set to 0 by default, indicating that the query starts from the first record.

limit

No

Integer

Definition

Maximum records to be queried

Constraints

N/A

Range

1–100

Default Value

By default, the first 100 records are queried.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

config_ips

Array of strings

Definition

Password-free configuration, which involves IP addresses and CIDR blocks. Only IPv4 addresses or CIDR blocks are supported.

total_count

Integer

Definition

Total number of password-free configurations

Range

N/A

Example Requests

GET https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/b31f6915c8be45e38958eac14e96a5d2in12/passwordless-config 

Example Responses

Status code: 200

Success

{ 
   "config_ips" : [ "10.23.26.0/24" ], 
   "total_count" : 1 
 }

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.