Updated on 2024-01-12 GMT+08:00

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.

Constraints

SSL cannot be configured when a DB instance is being created, rebooted, or upgraded, its specifications are being modified, or database users are being created or deleted.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Specifies the 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

Parameter description
Table 2 Parameter description

Name

Mandatory

Type

Description

ssl_option

Yes

boolean

Specifies whether to enable SSL.

  • true: Enable SSL.
  • false: Disable SSL.

Example Request

  • Enabling SSL for a DB instance
    {
         "ssl_option": true
    }
  • Disabling SSL for a DB instance
    {
         "ssl_option": false
    }

Response

Status Code

Error Code

For details, see Error Codes.