Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Enabling or Disabling SSL for a Proxy Instance
Updated on 2025-10-21 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:

Constraints

This API is in the open beta test (OBT) phase. To use it, submit a service ticket.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    gaussdbformysql:proxy:modifySSL

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    gaussdb:proxy:modifySSL

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

instance_id

Yes

String

Definition

Instance ID, which uniquely identifies an instance.

Constraints

N/A

Range

The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.

Default Value

N/A

proxy_id

Yes

String

Definition

Proxy instance ID, which is compliant with the UUID format.

Constraints

N/A

Range

The value contains 36 characters with a suffix of po01. Only letters and digits are allowed.

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

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

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

ssl_option

Yes

Boolean

Definition

Whether to enable SSL.

Constraints

N/A

Range

  • true: SSL is enabled.

  • false: SSL is disabled.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

job_id

String

Definition

Task ID.

Range

N/A

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

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy