Deze pagina is nog niet beschikbaar in uw eigen taal. We werken er hard aan om meer taalversies toe te voegen. Bedankt voor uw steun.

Enabling or Disabling SSL

Updated on 2023-10-18 GMT+08:00

Function

This API is used to enable or disable SSL. Before calling this API:

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID of a tenant in a project.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

  • en-us
  • zh-cn
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

ssl_option

Yes

Boolean

Whether to enable SSL.

  • true: SSL is enabled.
  • false: SSL is disabled.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Task ID.

Status code: 400

Table 5 Response body parameter

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameter

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Enabling SSL for a DB instance

PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/ssl-option
{
  "ssl_option" : true
}

Example Response

Status code: 200

Success.

{
  "job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback