ModifyDBClusterPrimaryZone - PolarDB - Alibaba Cloud Documentation Center

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

polardb:ModifyDBClusterPrimaryZone

update

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note Call the DescribeDBClusters operation to query the details of all clusters in a destination region, including their cluster IDs.	pc-**************
ZoneId	string	Yes	The ID of the new zone. Note Call the DescribeRegions operation to query available zones.	cn-hangzhou-g
ZoneType	string	No	The type of the zone. Valid values: Primary: The primary zone. Standby: The secondary zone.	Primary
VSwitchId	string	No	The ID of the vSwitch in the destination zone. Note This parameter is required for PolarDB for Oracle and PolarDB for PostgreSQL clusters. For PolarDB for MySQL clusters, this parameter is required if a vSwitch is created in the destination zone. If no vSwitch is created, the default vSwitch is used and this parameter is optional.	vsw-**************
IsSwitchOverForDisaster	string	No	Specifies whether to fail back to the original zone. Valid values: true: Fails back to the original zone. false: Does not fail back to the original zone.	false
PlannedStartTime	string	No	The earliest time to start the scheduled task to change the zone. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC. Note The start time must be a point in time within the next 24 hours. For example, if the current time is `2021-01-14T09:00:00Z`, you can set the start time to a value from `2021-01-14T09:00:00Z` to `2021-01-15T09:00:00Z`. If you do not specify this parameter, the zone change task is performed immediately.	2021-01-14T09:00:00Z
PlannedEndTime	string	No	The latest time to start the scheduled task. Specify the time in the `YYYY-MM-DDThh:mm:ssZ` format. The time must be in UTC. Note The latest start time must be at least 30 minutes later than the earliest start time. If you specify `PlannedStartTime` but not this parameter, the latest start time of the task is the value of `PlannedStartTime` plus 30 minutes by default. For example, if you set `PlannedStartTime` to `2021-01-14T09:00:00Z` and leave this parameter empty, the task starts no later than `2021-01-14T09:30:00Z`.	2021-01-14T09:30:00Z
FromTimeService	boolean	No	Specifies whether to perform the zone change immediately or at a scheduled time. Valid values: false (default): The zone change is performed at the scheduled time. true: The zone change is performed immediately.	false
VPCId	string	No	The ID of the virtual private cloud (VPC).	vpc-**********

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ED12C6FF-3261-4571-AB57-3570F6******

Examples

Success response

JSON format

{
  "RequestId": "ED12C6FF-3261-4571-AB57-3570F6******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ScheduleTaskExist	The specified cluster already has a scheduled task.	The specified cluster already has a scheduled task.
400	InvalidZoneId.Malformed	The specified parameter ZoneId is not valid.	The specified ZoneId parameter is invalid.
400	InvalidZoneId.Same	The specified parameter ZoneId is same with origin zoneId.	The specified ZoneId is the same as the original ZoneId.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	The request failed to be processed because unknown errors, exceptions, or failures have occurred.
403	ActionUnauthorized	The specified action is not available for you.	This operation cannot be performed.
403	OperationDenied.MutexLock	The operation is not permitted due to the mutex lock.	This operation cannot be performed because of a mutex.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
404	InsufficientResource	The specified target zone has insufficient resources.	The specified target zone has insufficient resources.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.