All Products
Search
Document Center

AnalyticDB:ModifyDBInstanceDeploymentMode

Last Updated:Jan 23, 2026

Changes the development mode of an instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
gpdb:ModifyDBInstanceDeploymentModeupdate
*DBInstance
acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The cluster ID.

Note You can call the DescribeDBInstances operation to query the IDs of all AnalyticDB for PostgreSQL instances in the specified region.
gp-xxxxxxxxx
DeployModestringYes

The deployment mode. Valid values:

  • multiple: Multi-zone development.
  • single: Single-zone deployment.
multiple
StandbyZoneIdstringNo

The ID of the secondary zone.

Note
  • This parameter must be specified only when DeployMode is set to multiple.

  • You can call the DescribeRegions operation to query the available zone list.

  • The ID of the secondary zone must be different from the ID of the primary zone.

cn-hangzhou-j
StandbyVSwitchIdstringNo

The vSwitch ID of the secondary zone.

Note
  • This parameter must be specified only when DeployMode is set to multiple.

  • The vSwitch must be deployed in the zone that is specified by the StandbyZoneId parameter.

vsw-bp1cpq8mr64paltkb****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The unique ID of the request.

ABB39CC3-4488-4857-905D-2E4A051D0521

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521"
}

Error codes

For a list of error codes, visit the Service error codes.