All Products
Search
Document Center

ApsaraDB RDS:DescribeHASwitchConfig

Last Updated:Mar 13, 2024

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

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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
rds:DescribeHASwitchConfigREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-uf6wjk5xxxxxxxxxx
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

4FDF4B79-2741-4C5F-8C76-4B953FC5C2B1
ManualHATimestring

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
HAConfigstring

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

Examples

Sample success responses

JSONformat

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

Error codes

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