You can call the GetDbProxyInstanceSsl operation to query the SSL encryption settings of the dedicated proxy endpoint of an ApsaraDB RDS instance.

ApsaraDB RDS provides the dedicated proxy feature. You can configure SSL encryption for the dedicated proxy endpoint of an instance. This allows you to ensure the data security of the instance. For more information about the dedicated proxy feature, see Dedicated proxy.

Before you call this operation, make sure that the following requirements are met:

  • The dedicated proxy feature must be enabled for the instance.
  • The minor engine version that the dedicated proxies of the instance run must be 1.12.8 or later.
  • The minor engine version of the instance must be 20200831 or later, and the instance must run the following MySQL versions and RDS editions:
    • MySQL 8.0 on RDS High-availability Edition with local SSDs
    • MySQL 5.7 on RDS High-availability Edition with local SSDs
    • MySQL 5.6 on RDS High-availability Edition with local SSDs

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetDbProxyInstanceSsl

The operation that you want to perform. Set the value to GetDbProxyInstanceSsl.

RegionId String No cn-hangzhou

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

DbInstanceId String Yes rm-t4n3axxxxx

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

DBProxyEngineType String No normal

An internal parameter. You do not need to specify this parameter.

Response parameters

Parameter Type Example Description
RequestId String D330E60C-8AAA-4D63-8F64-5B78F4692F98

The ID of the request.

DbProxyCertListItems Array of DbProxyCertListItems

An array that consists of SSL encryption settings.

DbProxyCertListItems
DbInstanceName String rm-t4n3axxxxx

The ID of the instance.

EndpointName String buxxxxxxx

The ID of the dedicated proxy endpoint.

EndpointType String RWSplit

The default identifier of the dedicated proxy endpoint. The value is fixed as RWSplit.

SslExpiredTime String 2021-12-16T08:43:20Z

The time when the certificate expires.

CertCommonName String test1234.rwlb.rds.aliyuncs.com

The dedicated proxy endpoint for which SSL encryption is enabled.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=GetDbProxyInstanceSsl
&DbInstanceId=rm-t4n3axxxxx
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<GetDbProxyInstanceSslResponse>
<RequestId>D330E60C-8AAA-4D63-8F64-5B78F4692F98</RequestId>
<DbProxyCertListItems>
    <DbProxyCertListItems>
        <EndpointName>buxxxxxxx</EndpointName>
        <EndpointType>RWSplit</EndpointType>
        <CertCommonName>test1234.rwlb.rds.aliyuncs.com</CertCommonName>
        <SslExpiredTime>2021-12-16T08:43:20Z</SslExpiredTime>
        <DbInstanceName>rm-t4n3axxxxx</DbInstanceName>
    </DbProxyCertListItems>
</DbProxyCertListItems>
</GetDbProxyInstanceSslResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "D330E60C-8AAA-4D63-8F64-5B78F4692F98",
  "DbProxyCertListItems" : {
    "DbProxyCertListItems" : [ {
      "EndpointName" : "buxxxxxxx",
      "EndpointType" : "RWSplit",
      "CertCommonName" : "test1234.rwlb.rds.aliyuncs.com",
      "SslExpiredTime" : "2021-12-16T08:43:20Z",
      "DbInstanceName" : "rm-t4n3axxxxx"
    } ]
  }
}

Error codes

HTTP status code Error code Error message Description
400 InvalidVpcInstanceId The specified VPC instance ID is invalid. The error message returned because the specified VPC ID is invalid.
400 InvalidDBInstanceName Specified parameter DBInstanceName is not valid. The error message returned because the value of the DBInstanceName parameter is invalid. Check whether the value is null or an empty string.
403 IncorrectDBInstanceType The current database instance type does not support the operation. The error message returned because the configuration of the instance does not support this operation.
404 InvalidDBInstance.NotFound The specified instance does not exist or is not supported. The error message returned because the specified instance cannot be found. Check the ID of the instance.
404 Endpoint.NotFound The specified endpoint is not found. The error message returned because the specified endpoint cannot be found.

For a list of error codes, visit the API Error Center.