Configuring SSL

Function

This API is used to configure SSL to encrypt connections.

• Before calling an API, you need to understand the API in Authentication.
• Before calling this API, learn about request header parameters.

Constraints

SSL cannot be configured if the DB instance is in any of the following statuses: creating, rebooting, upgrading, changing instance class, creating users, or deleting users.

This API is supported only for RDS for MySQL instances.

URI

• URI format

  PUT /v3/{project_id}/instances/{instance_id}/ssl

• Parameter description

  Table 1 Parameter description

  Name	Mandatory	Description
  project_id	Yes	Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
  instance_id	Yes	Specifies the DB instance ID.

Request

Example Request

• Enable SSL for a DB instance.

  PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ssl
  
  {
       "ssl_option": true
  }

• Disable SSL for a DB instance.

  {
       "ssl_option": false
  }

Response

• Normal response

  Parameter	Description
  job_id	Task ID.

• Example normal response

  {
        "job_id":"83abc7bc-2c70-4534-8565-351187b37715"
  }

• Abnormal response

  For details, see Abnormal Request Results.

Status Code

• Normal

  200

• Abnormal

  For details, see Status Codes.

Error Code

For details, see Error Codes.