All Products
Document Center

ApsaraDB RDS:ModifyHADiagnoseConfig

Last Updated:May 11, 2024

Change the availability check method of an instance.

Operation description

Supported database engines

  • MySQL
  • PostgreSQL
  • SQL Server
  • MariaDB


Note Before you call this operation, read the following documentation and make sure that you fully understand the prerequisites and impacts of this operation.

What is availability check?


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
  • DBInstance
  • rds:ResourceTag

Request parameters


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


The availability check method of the instance. Valid values:

  • SHORT: Alibaba Cloud uses short-lived connections to check the availability of the instance.
  • LONG: Alibaba Cloud uses persistent connections to check the availability of the instance.

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


Response parameters


The response parameters.


The ID of the request.



Sample success responses


  "RequestId": "9EFA6DF3-5247-4D9D-80AA-68765BE6D5EA"

Error codes

HTTP status codeError codeError message
400HaDiagnoseConfig.FormatThe value of tcpConnectionType must be LONG or SHORT

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

Change history

Change timeSummary of changesOperation
No change history