Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query SSL activation status. If SSL has been enabled, it will synchronously return the certificate download URL.
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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | No | String | Instance ID, which can be obtained through the DescribeDBInstances API. Description: Fill in either the instance ID or the read-only group ID. To query the SSL activation status of two-node or three-node instances, enter the instance ID parameter. Single-node (cloud disk) and cloud disk edition instances do not support enabling SSL, so queries are not supported. |
| RoGroupId | No | String | Read-only group ID. Obtain through the DescribeRoGroups API. Description: Fill in either the instance ID or the read-only group ID. To query the SSL activation status of a read-only instance or read-only group, fill in the RoGroupId parameter. Note that you should always enter the read-only group ID. Single-node (cloud disk) and cloud disk edition instances do not support enabling SSL, so they do not support querying. |
| Parameter Name | Type | Description |
|---|---|---|
| Status | String | Whether to enable SSL. ON represents enabled, OFF represents not enabled. |
| Url | String | Certificate download URL. |
| 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 instance 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 | The instance does not exist. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan