Enabling or Disabling SSL

API Description

This API is used to enable or disable SSL.

Constraints

This operation cannot be performed on frozen or abnormal instances.
The DB instance must be restarted to make changes take effect. Exercise caution when enabling or disabling SSL.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
dds:instance:setSSL	permission_management	instance	g:EnterpriseProjectId	dds:instance:modifySSL	-

URI

URI format
POST /v3/{project_id}/instances/{instance_id}/switch-ssl
URI example
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switch-ssl

**Table 1** URI parameters
Name	Mandatory	Type	IN	Description
project_id	Yes	string	path	Definition Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	string	path	Definition Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If you do not have an instance, call the API described in Creating a DB Instance to create one. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Request header parameters
Name	Mandatory	Type	IN	Description
X-Auth-Token	Yes	string	header	Definition User token obtained from IAM. For details, see Authentication. Constraints N/A Range N/A Default Value N/A

**Table 3** Parameter description
Name	Type	Mandatory	Description
ssl_option	String	Yes	Definition Whether to enable or disable SSL. Constraints N/A Range The value 0 indicates that SSL is disabled by default. The value 1 indicates that SSL is enabled by default. Default Value N/A

Example Request

Disabling SSL for a DB instance (SSL is disabled by default.)

{
    "ssl_option": "0"
}

Response

Parameter description

**Table 4** Parameter description
Name	Type	Mandatory	Description
job_id	String	Yes	Definition The workflow ID. Value range: N/A
ssl_option	String	Yes	Definition Whether to enable or disable SSL. Value range: The value 0 indicates that SSL is disabled by default. The value 1 indicates that SSL is enabled by default.

Example Response

{
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5",
    "ssl_option": "0"  
}

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.