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

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

Table 1 Path parameters

Name

Type

IN

Mandatory

Description

project_id

string

path

Yes

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

instance_id

string

path

Yes

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.

Request Parameters

Table 2 Request header parameters

Parameter

Type

IN

Mandatory

Description

X-Auth-Token

string

header

Yes

User token
Table 3 Parameter description

Parameter

Type

Mandatory

Description

ssl_option

String

Yes

Whether to enable or disable SSL.

Valid value:

  • The value 0 indicates that SSL is disabled by default.
  • The value 1 indicates that SSL is enabled by default.
  • Request example 
    {
    "ssl_option": "0"
}

Response Parameters

Table 4 Parameter description

Parameter

Type

Mandatory

Description

job_id

String

Yes

The workflow ID.

ssl_option

String

Yes

Whether to enable or disable SSL.

Valid value:

  • 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"  
}

Status Code

For details, see Status Code.

Error Code

For details, see Error Code.

Parent topic: DB Instance Management