Help Center/ Document Database Service/ API Reference/ APIs V3.0 (Recommended)/ DB Instance Management/ Enabling or Disabling SSL
Updated on 2025-08-22 GMT+08:00
View PDF

Enabling or Disabling SSL

API Description

This API is used to enable or disable SSL.

Restrictions

  • 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.

URI

  • URI format

    POST https://{Endpoint}/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 Request parameters

Name

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

Explanation:

User token obtained from IAM. For details, see Authentication.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

project_id

string

path

Yes

Explanation:

Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

instance_id

string

path

Yes

Explanation:

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

Value range:

N/A

Default value:

N/A

Request Parameters

  • Parameter description
    Table 2 Parameter description

    Name

    Type

    Mandatory

    Description

    ssl_option

    String

    Yes

    Explanation:

    Whether to enable or disable SSL.

    Constraints:

    N/A

    Value 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 Parameters

  • Parameter description
    Table 3 Parameter description

    Name

    Type

    Mandatory

    Description

    job_id

    String

    Yes

    Explanation:

    The workflow ID.

    Value range:

    N/A

    ssl_option

    String

    Yes

    Explanation:

    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.
  • Response example 
    {
    "job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5",
    "ssl_option": "0"  
}

Status Code

For more information, see Status Code.

Error Code

For more information, see Error Code.

Parent topic: DB Instance Management