Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Enabling or Disabling SSL for a Proxy Instance
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Enabling or Disabling SSL for a Proxy Instance

Function

This API is used to enable or disable SSL for a proxy instance. Before calling this API:

URI

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

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.

proxy_id

Yes

String

Proxy instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

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

Values:

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

Parameter

Mandatory

Type

Description

ssl_option

Yes

Boolean

Whether to enable SSL.

Values:

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Task ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Enabling SSL

PUT https://{endpoint}/v3/056538411200d4cd2f79c003c7606412/instances/096c0fc43e804757b59946b80dc27f8bin07/proxyId/2ec617ba62da4eafb921b69438beed3cpo01/ssl

{
  "ssl_option" : true
}

Example Response

Status code: 200

Success.

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

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy