Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Protection/ Querying the Replication Capability
Updated on 2026-08-10 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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v3/{project_id}/replication-capabilities

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token.

You can obtain it by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

regions

Array of ProtectableReplicationCapabilitiesRespRegion objects

Definition

List of regions that support replication.

Range

N/A

Table 4 ProtectableReplicationCapabilitiesRespRegion

Parameter

Type

Description

name

String

Definition

Region where the cloud service resides.

Range

N/A

replication_destinations

Array of strings

Definition

List of destination regions where backups can be replicated to.

For details, see Replication-supported regions.

Range

N/A

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.