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

Enabling or Disabling ALT for a Proxy Instance

Function

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

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 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:modifyAlt

    Write

    instance *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>
    • gaussdb:instance:modifyProxy
    • gaussdb:proxy:modifyAlt

    -

URI

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

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.

To obtain this value, log in to the console, choose Instances, and find the target instance ID in the instance list.

Constraints

N/A

Range

The value contains 36 characters. 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.

To obtain this value, log in to the console, choose Instances, and click the instance name. On the displayed page, choose Database Proxy and find the target proxy instance ID in the list.

Constraints

N/A

Range

The value contains 36 characters. 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

Content-Type

Yes

String

Definition

Content type.

Constraints

N/A

Range

application/json

Default Value

application/json

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

alt_enabled

Yes

String

Definition

Whether ALT is enabled.

Constraints

N/A

Range

  • on: enabled

  • off: disabled

Default Value

N/A

alt_for_readonly

No

String

Definition

Whether read replica ALT is enabled.

Constraints

N/A

Range

  • on: enabled

  • off: disabled

Default Value

off

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 ALT and read replica ALT for a proxy instance

    PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/proxy/0f46fc46396e4fb19a0cb52f578e9511po01/alt

{
  "alt_enabled" : true,
  "alt_for_readonly" : true
}

  • Disabling ALT and read replica ALT for a proxy instance

    PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/proxy/0f46fc46396e4fb19a0cb52f578e9511po01/alt

{
  "alt_enabled" : false,
  "alt_for_readonly" : false
}

Example Response

Status code: 200

Success.

{
  "job_id" : "a4217ac4-12cd-4fb3-acfc-db4a4a1896ea"
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent Topic: Database Proxy