Help Center/ Data Encryption Workshop/ API Reference/ API/ Key Management APIs/ Multi-Region Key/ Querying the Regions Supported by a Cross-Region Key
Updated on 2026-09-21 GMT+08:00

Querying the Regions Supported by a Cross-Region Key

Function

  • Function: Query the regions supported by a cross-region key.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/kms/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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition

Number of returned records

Constraints

The value of limit must be a number.

Range

0 to 100

Default Value

100

offset

No

Integer

Definition

Index location. The query starts from the next data record specified by offset.

Constraints

N/A

Range

N/A

Default Value

0

Request Parameters

Table 3 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.

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 4 Response body parameters

Parameter

Type

Description

regions

Array of strings

Definition

Region information

Range

N/A

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "regions" : [ "cn-north-2", "cn-north-4", "cn-north-1" ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.