Function

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 port number modifications take effect. Exercise caution when enabling or disabling SSL.

URI

• URI format

  POST/v3/{project_id}/instances/{instance_id}/switch-ssl

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Specifies the project ID of a tenant in a region.
  instance_id	Yes	Specifies the DB instance ID.

Requests

• Parameter description

  Table 2 Parameter description

  Name	Mandatory	Type	Description
  ssl_option	Yes	String	Specifies 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 header

  POST https://DDS endpoint/v3/{project_id}/instances/{instance_id}/switch-ssl

• Example request

  {
      "ssl_option": "0"
  }

Responses

• Parameter description

  Table 3 Parameter description

  Name	Type	Description
  job_id	String	Indicates the workflow ID.
  ssl_option	String	Indicates 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.

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