Updated on 2026-09-21 GMT+08:00

Querying Regions Supported by Multi-Region Secrets

Function

This API is used to query regions supported by multi-region secrets.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/csms/replica-regions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

The value returned by the IAM API is used, which contains 32 characters.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. This parameter is optional if AK/SK authentication is used.

Constraints

N/A

Range

Obtain the value by calling the IAM API for obtaining the user token.

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

regions

Array of strings

Definition

Regions supported by multi-region replicas

Range

N/A

total

Integer

Definition

Total number of supported regions

Range

N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "regions" : [ "cn-test-x" ],
  "total" : 1
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.