Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to query the SSL authentication information of an instance, such as enablement status, configuration status, and certificate address.
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: 2018-04-12. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID |
Parameter Name | Type | Description |
---|---|---|
CertDownloadUrl | String | Download address for SSL certificate |
UrlExpiredTime | String | Expiration time of the certificate download address |
SSLConfig | Boolean | Whether the SSL is enabled for the identified instance. - true : Enabled- false : Disabled |
FeatureSupport | Boolean | Whether SSL is supported for the identified instance. - true : Supported- false : Not supported |
Status | Integer | Status of SSL configuration - 1 : Configuring- 2 : Configured successfully |
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. |
This example shows you how to query the SSL authentication information of an instance.
https://redis.intl.tencentcloudapi.com/?Action=DescribeSSLStatus
&InstanceId=crs-2btr9ryn
&<Common request parameters>
{
"Response": {
"CertDownloadUrl": "https://tencentdb-user-crt-12XXXXXXX.cos.ap-nanjing.myqcloud.com/TencentDB-SSL-CA.zip",
"FeatureSupport": true,
"RequestId": "eda7856c-9985-4d11-b5b0-48f703XXXXXX",
"SSLConfig": false,
"Status": 2,
"UrlExpiredTime": "2042-06-16 20:29:32"
}
}
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 |
---|---|
FailedOperation.SystemError | Internal system error, which is irrelevant to the business. |
InternalError | Internal error. |
InvalidParameter | Incorrect parameter. |
InvalidParameter.ActionNotFound | The corresponding API was not found. |
InvalidParameter.PermissionDenied | The API has no CAM permissions. |
InvalidParameterValue.UnSupportedType | The instance type is not supported. |
ResourceNotFound.InstanceNotExists | No Redis instance is found by the serialId. |
ResourceUnavailable.InstanceStatusError | Operation unsupported: the instance is exceptional. |
Was this page helpful?