产品动态
公告
Domain name for API request: mongodb.intl.tencentcloudapi.com.
This API is used to set the SSL status for an instance.
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: InstanceEnableSSL. |
| 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. |
| Enable | Yes | Boolean | Configures whether to enable SSL for access. - true: enabled. - false: disabled. |
| Parameter Name | Type | Description |
|---|---|---|
| Status | Integer | SSL enabling status. - 0: disabled. - 1: enabled. Note: This field may return null, indicating that no valid values can be obtained. |
| ExpiredTime | String | Certificate file 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 | Download URL of the certificate file. Note: This field may return null, indicating that no valid values can be obtained. |
| FlowId | Integer | Process ID. |
| 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 disable SSL.
https://mongodb.intl.tencentcloudapi.com/?Action=InstanceEnableSSL
&InstanceId=cmgo-eqmoaxxx
&Enable=true
&<Common request parameters>{
"Response": {
"CertUrl": "https://cert-****",
"ExpiredTime": "2024-03-29 13:40:56",
"RequestId": "5297ebe2-63f8-465f-be7d-41058ce438",
"Status": 1
}
}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 | Internal error |
| InvalidParameterValue.LockFailed | Instance lock failed. |
| 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. |
文档反馈