DescribeDBInstanceHA - 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

polardbx:DescribeDBInstanceHA

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
DBInstanceName	string	Yes	The name of the PolarDB-X instance.	pxc-htri0ori2r****

Response elements

Element	Type	Description	Example
	object
Message	string	The error message.	successs
RequestId	string	The request ID.	1A6D328C-84B8-40DC-BF49-6C73984D7494
Success	boolean	Indicates whether the request is successful.
Data	object	The high availability deployment information of the instance.
TopologyType	string	The high availability topology type of the instance.	3azones
PrimaryRegionId	string	The region ID of the primary node.	cn-hangzhou
PrimaryAzoneId	string	The zone ID of the primary node.	cn-hangzhou-d
SecondaryRegionId	string	The region ID of the secondary node.	cn-hangzhou
SecondaryAzoneId	string	The zone ID of the secondary node.	cn-hangzhou-b

Examples

Success response

JSON format

{
  "Message": "successs",
  "RequestId": "1A6D328C-84B8-40DC-BF49-6C73984D7494",
  "Success": false,
  "Data": {
    "TopologyType": "3azones",
    "PrimaryRegionId": "cn-hangzhou",
    "PrimaryAzoneId": "cn-hangzhou-d",
    "SecondaryRegionId": "cn-hangzhou",
    "SecondaryAzoneId": "cn-hangzhou-b"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.