Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Protection/ Querying the Replication Capability
Updated on 2024-12-20 GMT+08:00

Querying the Replication Capability

Function

This API is used to query the replication capability of the current region.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v3/{project_id}/replication-capabilities

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

regions

Array of ProtectableReplicationCapabilitiesRespRegion objects

List of regions that support replication

Table 4 ProtectableReplicationCapabilitiesRespRegion

Parameter

Type

Description

name

String

Region where the cloud service resides

replication_destinations

Array of strings

List of supported destination regions

Example Requests

GET https://{endpoint}/v3/{project_id}/replication-capabilities

Example Responses

Status code: 200

OK

{
  "regions" : [ {
    "replication_destinations" : [ "cn-shenzhen-1", "cn-hk1" ],
    "name" : "southchina"
  } ]
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.