CreateDBClusterBinding - ApsaraDB for SelectDB - Alibaba Cloud Documentation Center

Creates a binding relationship for clusters. If the zone-redundant storage (ZRS) deployment method is used, you can create a binding relationship between two clusters.

Operation description

This operation is supported only for instances that use the zone-redundant storage (ZRS) feature and meet the following requirements:

The instance clusters reside in different zones.
The billing method of the instance clusters is consistent.

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

selectdb:CreateDBClusterBinding

update

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	selectdb-cn-7213cjv2ez
DBClusterId	string	Yes	The cluster ID.	selectdb-cn-7213cjv2ez-be
DBClusterIdBak	string	Yes	The cluster ID.	selectdb-xxxb9f2w-be
RegionId	string	No	The region ID	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	4773E4EC-025D-509F-AEA9-D53123FDFB0F
Data	object	The data returned.
DbInstanceName	string	The instance ID.	selectdb-cn-7213cjv2ez
DbInstanceId	string	The numeric ID.	6585
DbClusterId	string	The cluster ID.	selectdb-cn-7213cjv2ez-be

Examples

Success response

JSON format

{
  "RequestId": "4773E4EC-025D-509F-AEA9-D53123FDFB0F\n",
  "Data": {
    "DbInstanceName": "selectdb-cn-7213cjv2ez",
    "DbInstanceId": "6585",
    "DbClusterId": "selectdb-cn-7213cjv2ez-be"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	SystemError	A system error occurred while processing your request.	The system is abnormal.
400	ClusterNotSupport	Current instance cluster does not support this operation.	The operation is not supported in the current cluster state.
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	english description1
400	InvalidChargeType.NotSupport	The specified parameter "ChargeType" does not meet the requirements.
403	DBClusterNotSupported	The requested operation can not be performed while the cluster is not sale.	The requested operation cannot be performed while the cluster is not running.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	english description1
404	DBInstanceLocked	The current instance lock mode does not support this operation.	english description1
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	Instance does not exist.
404	InvalidParam	Invalid parameter, please check.
404	InvalidClusterName.NotFound	The specified cluster name is not available.	The specified cluster name is not available

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.