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
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| limit | No | Integer | Number of returned records. The default value is 10. |
| offset | No | Integer | Index location. The query starts from the next data record specified by offset. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | 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. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| regions | Array of strings | Region information |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 502
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
Status code: 504
| Parameter | Type | Description |
|---|---|---|
| error | Object | Error message |
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code returned by the error request |
| error_msg | String | Error information returned by the error request |
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. |
| 400 | Invalid request parameter. |
| 401 | Username and password are required for the requested page. |
| 403 | Authentication failed. |
| 404 | The resource does not exist. |
| 500 | Internal service error. |
| 502 | Request failed. The server has received an invalid response. |
| 504 | Gateway timed out. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
