CreateSitePair

Updated at:

Creates a disaster recovery site pair.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdr:CreateSitePair

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

SitePairType

string

No

The site pair type.

Valid values:

  • cloud2cloud :

    cloud2cloud

  • zone2zone :

    zone2zone

cloud2cloud

PrimarySiteName

string

No

The name of the primary site.

Hangzhou Zone G

PrimarySiteType

string

No

The type of the primary site.

cloud

PrimarySiteRegionId

string

No

The region ID of the primary site.

cn-shanghai

PrimarySiteVpcId

string

No

The VPC ID of the primary site.

vpc-uf6j3rao8wkr7hb4uopv2

PrimarySiteZoneId

string

No

The zone ID of the primary site. This parameter is valid only when the site pair type is cross-zone disaster recovery.

cn-hangzhou-g

SecondarySiteName

string

No

The name of the secondary site.

Hangzhou Zone F

SecondarySiteType

string

No

The type of the secondary site.

cloud

SecondarySiteRegionId

string

No

The region ID of the secondary site.

cn-hangzhou

SecondarySiteVpcId

string

No

The VPC ID of the secondary site.

vpc-bp1wu55gbyqd7gh3yu3ey

SecondarySiteZoneId

string

No

The zone ID of the secondary site. This parameter is valid only when the site pair type is cross-zone disaster recovery.

cn-hangzhou-i

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

D14F1EB0-30B7-5A38-92E7-C2D11077D5CA

Success

boolean

Indicates whether the request is successful.

True

Code

string

The return code.

200

Message

string

The error message.

successful

SitePairId

string

The site pair ID.

s-000bvn4shsuhq4cph5i8

SecondarySiteId

string

The ID of the secondary site.

si-000imvpcegvbh6i5kd2u

PrimarySiteId

string

The ID of the primary site.

si-0001jntih0phb0i2w1ya

Examples

Success response

JSON format

{
  "RequestId": "D14F1EB0-30B7-5A38-92E7-C2D11077D5CA",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "SitePairId": "s-000bvn4shsuhq4cph5i8",
  "SecondarySiteId": "si-000imvpcegvbh6i5kd2u",
  "PrimarySiteId": "si-0001jntih0phb0i2w1ya"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.