Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query the SSL enabling status. If the SSL is enabled, the certificate download link will be returned synchronously.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeSSLStatus. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| InstanceId | No | String | Instance ID, which can be obtained through the DescribeDBInstances API. Note: Either the instance ID or read-only group ID parameter needs to be specified. To query the enabling status of the SSL for two-node or three-node instances, you need to specify the instance ID parameter. Single-node (cloud disk) and Cluster Edition instances do not support enabling SSL; thus, queries are not supported. |
| RoGroupId | No | String | Read-only group ID, which can be obtained through the DescribeRoGroups API. Note: Either the instance ID or read-only group ID parameter needs to be specified. To query the enabling status of the SSL for read-only instances or groups, you need to specify the RoGroupId parameter. Note that the value should be the read-only group ID. Single-node (cloud disk) and Cluster Edition instances do not support enabling SSL; thus, queries are not supported. |
| Parameter Name | Type | Description |
|---|---|---|
| Status | String | Whether SSL is enabled. ON indicates enabled; OFF indicates not enabled. |
| Url | String | Certificate download link. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSSLStatus
<Common request parameters>
{
"InstanceId": "cdb-je5dfmdl"
}
{
"Response": {
"Status": "ON",
"Url": "http://***download.url",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.DBRecordNotExistError | The database record does not exist. |
| InternalError.ExecHttpRequestError | Failed to execute the HTTP request |
| InternalError.UnknownError | Unknown error |
| InvalidParameter.ControllerNotFoundError | This API was not found. |
| InvalidParameter.JsonUnmarshalError | Failed to deserialize JSON. |
| MissingParameter.MissingParamError | Required parameters are missing. |
| ResourceNotFound.InstanceNotFoundError | High-availability instance doesn’t exist. |
フィードバック