Updates the SSL settings for a PolarDB-X instance.

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 UpdateDBInstanceSSL

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

EnableSSL Boolean Yes true

Specifies whether to enable SSL.

CertCommonName String Yes pxc-hzrqjarxdocd4t.polarx.rds.aliyuncs.com

The domain name to which the certificate is bound.

DBInstanceName String Yes pxc-hzjasd****

The ID of the instance.

RegionId String No cn-hangzhou

The ID of the region.

Response parameters

Parameter Type Example Description
RequestId String FEA5DC20-6D8A-5979-97AA-FC57546ADC20

The ID of the request.

Data Object

The data returned by the request.

TaskId Long 2209883

The ID of the backend task.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateDBInstanceSSL
&EnableSSL=true
&CertCommonName=pxc-hzrqjarxdocd4t.polarx.rds.aliyuncs.com
&DBInstanceName=pxc-hzjasd****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

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

<UpdateDBInstanceSSLResponse>
    <RequestId>FEA5DC20-6D8A-5979-97AA-FC57546ADC20</RequestId>
    <Data>
        <TaskId>2209883</TaskId>
    </Data>
</UpdateDBInstanceSSLResponse>

JSON format

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

{
  "RequestId" : "FEA5DC20-6D8A-5979-97AA-FC57546ADC20",
  "Data" : {
    "TaskId" : 2209883
  }
}

Error codes

HttpCode Error code Error message Description
404 InvalidDBInstance.NotFound The specified DB instance does not exist. The error message returned because the specified database instance does not exist.

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