Checking RDS Connectivity (a V3 API)

Function

This API is used to check the RDS connectivity.

Constraints

None

API Calling

For details, see Calling APIs.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ddm:instance:checkDataNodeConnection	Read	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	ddm:instance:list	-

URI

POST /v3/{project_id}/instances/{instance_id}/rds/connection

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in09. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
infos	Yes	Array of EsdbCheckRdsConnectionRequestV3 objects	Definition A collection of information related to checking RDS connectivity. Constraints N/A Range N/A Default Value N/A

**Table 3** EsdbCheckRdsConnectionRequestV3
Parameter	Mandatory	Type	Description
endpoint	Yes	String	Definition Private IP address and database port of the RDS instance. The format is xx.xx.xx.xx:xx. Constraints N/A Range N/A Default Value N/A
username	Yes	String	Definition RDS account. Constraints N/A Range N/A Default Value N/A
password	Yes	String	Definition RDS account password. Constraints N/A Range N/A Default Value N/A
rds_instance_id	Yes	String	Definition RDS instance ID, which uniquely identifies the instance. Constraints N/A Range The value contains 36 characters with a suffix of in01. Only letters and digits are allowed. Default Value N/A

Example Request

Checking RDS connectivity

POST https://{endpoint}/v3/a8e2a5e2a6xxxxxxxxxx5af5b9ddabe5/instances/b7eabbbc6bxxxxxxxxxxadfffa99a7c2in09/rds/connection

{
  "infos" : [ {
    "endpoint" : "***.**.***.***:****",
    "username" : "root",
    "password" : "********",
    "rds_instance_id" : "b944d6e9a8xxxxxxxxxx74e257b83c84in01"
  } ]
}

Response Parameters

Normal response

**Table 4** Response body parameters
Parameter	Type	Description
rds_check_infos	Array of CheckRdsConnectionResqVO objects	Definition A collection of information related to the RDS connectivity test. Range N/A

**Table 5** CheckRdsConnectionResqVO
Parameter	Type	Description
rds_instance_id	String	Definition RDS instance ID, which uniquely identifies the instance. Range The value contains 36 characters with a suffix of in09. Only letters and digits are allowed.
success	String	Definition Whether the connection is successful. Range true: The RDS connectivity test passed. false: The RDS connectivity test failed.
error_code	String	Definition Error code of the connectivity check failure. Range N/A
error_message	String	Definition Cause of the connectivity check failure. Range N/A

Example Response

Normal response example

{
  "rds_check_infos" : [ {
    "rds_instance_id" : "b3110ddff4xxxxxxxxxx7f2b752cd2a70in01",
    "success" : "true",
    "error_code" : null,
    "error_message" : null
  } ]
}