DescribeInstanceSSL

Last updated:2025-12-03 10:42:05

DescribeInstanceSSL

Last updated: 2025-12-03 10:42:05

1. API Description

Domain name for API request: mongodb.intl.tencentcloudapi.com.

This API is used to view the enabling status of Secure Sockets Layer (SSL) for an instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeInstanceSSL.
Version	Yes	String	Common Params. The value used for this API: 2019-07-25.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID, in the format of cmgo-p8vnipr5. It is the same as the format of the instance ID displayed on the TencentDB for MongoDB console page.

3. Output Parameters

Parameter Name	Type	Description
Status	Integer	SSL enabling status. 0 indicates disabled; 1 indicates enabled. Note: This field may return null, indicating that no valid values can be obtained.
ExpiredTime	String	Certificate expiration time, in the format of 2023-05-01 12:00:00. Note: This field may return null, indicating that no valid values can be obtained.
CertUrl	String	Certificate download URL. Note: This field may return null, indicating that no valid values can be obtained.
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.

4. Example

Example1 Viewing the Enabling Status of SSL for an Instance

Input Example

https://mongodb.intl.tencentcloudapi.com/?Action=DescribeInstanceSSL
&InstanceId=cmgo-eqmoaxxx
&<Common request parameters>

Output Example

{
    "Response": {
        "Status": 1,
        "ExpiredTime": "2023-05-04 12:13:00",
        "CertUrl": "http://sample/cert",
        "RequestId": "12345-abcdef"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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	Internal error
InvalidParameterValue.NotFoundInstance	The instance was not found.
UnsupportedOperation	Unsupported operation
UnsupportedOperation.KernelVersionNotSupport	Not supported for kernel versions.
UnsupportedOperation.SecondaryVersionNotSupportAudit	Not supported for minor versions.
UnsupportedOperation.VersionNotSupport	The current version does not support the operation.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud