Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Enabling or Disabling Access Control
Updated on 2025-07-29 GMT+08:00

Enabling or Disabling Access Control

Function

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

URI

POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/access-control-switch

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

open_access_control

Yes

Boolean

Definition

Whether to enable access control.

Constraints

N/A

Range

  • true: enabled

  • false: disabled

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

open_access_control

Boolean

Definition

Whether access control is enabled.

Range

  • true: enabled

  • false: disabled

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 access control
    POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/access-control-switch
    
    {
      "open_access_control" : true
    }
  • Disabling access control
    POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/access-control-switch
    
    
    {
      "open_access_control" : false
    }

Example Response

Status code: 200

Success.

  • Enabling access control
    {
      "open_access_control" : true
    }
  • Disabling access control
    {
      "open_access_control" : false
    }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.