DescribeInstanceSwitchAzone - PolarDB - Alibaba Cloud Documentation Center

Call the DescribeInstanceSwitchAzone operation to check whether you can switch the zone of an instance.

Debug

You can run this operation directly in OpenAPI Explorer. This eliminates the need to calculate signatures. After a successful call, OpenAPI Explorer automatically generates sample code for a software development kit (SDK).

Request parameters

Name	Type	Required	Example	Description
Action	String	Yes	DescribeInstanceSwitchAzone	A required parameter. Set the value to DescribeInstanceSwitchAzone.
DrdsInstanceId	String	Yes	drdsxxxxxxxxxxxx	The instance ID.

Return Data

Name	Type	Example	Description
RequestId	String	DSSDF-SEWE-23ERW	The request ID.
Result	Struct		The query results.
OriginAzoneId	String	cn-hangzhou-a	The ID of the source zone.
RegionId	String	cn-hangzhou	The region ID.
SwitchAble	Boolean	true	Indicates whether you can switch the zone.
TargetAzones	List	cn-hangzhou-a,cn-hangzhou-b	The destination zones.
Success	Boolean	true	Indicates whether the request was successful.

Examples

Request example

http(s)://drds-api.cn-hangzhou.aliyuncs.com/?Action=DescribeInstanceSwitchAzone
&DrdsInstanceId=drdsxxxxxxxxxxxx
&<Common request parameters>

Response example

XML format

<DescribeInstanceSwitchAzoneReponse>
  <RequestId>DSSDF-SEWE-23ERW</RequestId>
  <Success>true</Success>
  <Result>
        <OriginAzoneId>cn-hangzhou-a</OriginAzoneId>
        <TargetAzones>
              <TargetAzone>cn-hangzhou-a,cn-hangzhou-b</TargetAzone>
        </TargetAzones>
        <RegionId>cn-hangzhou</RegionId>
        <SwitchAble>true</SwitchAble>
  </Result>
</DescribeInstanceSwitchAzoneReponse>

JSON format

{"RequestId":"DSSDF-SEWE-23ERW","Success":"true","Result":{"OriginAzoneId":"cn-hangzhou-a","TargetAzones":{"TargetAzone":"cn-hangzhou-a,cn-hangzhou-b"},"RegionId":"cn-hangzhou","SwitchAble":"true"}}

Error codes

For more information about error codes, see the Error Center.