DescribeHASwitchConfig - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the settings of the automatic primary/secondary switchover feature for an instance.

Operation description

There is currently no authorization information disclosed in the API.

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5xxxxxxxxxx
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	4FDF4B79-2741-4C5F-8C76-4B953FC5C2B1
ManualHATime	string	The time when the automatic primary/secondary switchover feature is enabled again. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-08-29T15:00:00Z
HAConfig	string	The status of the automatic primary/secondary switchover feature. Valid values: Auto: The automatic primary/secondary switchover feature is enabled. The system automatically switches your workloads over from the instance to its secondary instance in the event of a fault. Manual: The automatic primary/secondary switchover feature is temporarily disabled.	Manual

Sample success responses

JSONformat

{
  "RequestId": "4FDF4B79-2741-4C5F-8C76-4B953FC5C2B1",
  "ManualHATime": "2019-08-29T15:00:00Z",
  "HAConfig": "Manual"
}

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

Change time	Summary of changes	Operation
2024-11-20	API Description Update. The Error code has changed	View Change Details