ModifyDBInstanceSSL

Last updated: 2025-10-28 22:49:21

ModifyDBInstanceSSL

Last updated: 2025-10-28 22:49:21

1. API Description

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

This API is used to enable/disable/update SSL encryption.

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: ModifyDBInstanceSSL.
Version	Yes	String	Common Params. The value used for this API: 2018-03-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	Yes	String	Instance ID.
Type	Yes	String	Operation type. enable - enable SSL; disable - disable SSL; renew - update the validity period of the certificate.
WaitSwitch	Yes	Integer	Operation settings. 0 - execute immediately; 1 - execute within the maintenance time. The default value is 0.
IsKMS	No	Integer	Whether it is protected through KMS encryption. 0 - no; 1 - yes. The default value is 0.
KeyId	No	String	This parameter is required when the value of IsKMS is 1.
KeyRegion	No	String	This parameter is required when the value of IsKMS is 1.

3. Output Parameters

Parameter Name	Type	Description
FlowId	Integer	Asynchronous task flow 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.

4. Example

Example1 Enabling/Disabling/Updating SSL Encryption

This example shows you how to enable/disable/update SSL encryption.

Input Example

POST / HTTP/1.1
Host: sqlserver.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceSSL
<Common request parameters>

{
    "InstanceId": "mssql-j8kv137v",
    "Type": "enable",
    "WaitSwitch": 0
}

Output Example

{
    "Response": {
        "FlowId": 100001,
        "RequestId": "9db13c19-d660-43c4-b340-7ba86b7b1470"
    }
}

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
FailedOperation.DBError	Database error.
FailedOperation.GcsError	The operation failed or the network timed out.
InvalidParameter.InputIllegal	Input error.
ResourceUnavailable.InstanceStatusInvalid	Invalid instance status.
UnsupportedOperation.NotSupportRepeat	Repeated operations are not supported.

Was this page helpful?

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

Yes

Feedback

tencent cloud