Updated on 2024-09-11 GMT+08:00

Adding Proxy Nodes

Function

This API is used to add proxy nodes. Before calling this API:

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Adding Proxy Nodes) before then.

  • Database proxy is unavailable for DB instances in a DeC.

URI

  • URI format

    POST https://{endpoint}/mysql/v3/{project_id}/instances/{instance_id}/proxy/enlarge

  • Example

    post https://{endpoint}/mysql/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/enlarge

  • Parameter description
    Table 1 Parameter description

    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, which is compliant with the UUID format.

Request

Table 2 Parameter description

Parameter

Mandatory

Type

Description

node_num

Yes

Integer

The number of proxy nodes to be added. The value is an integer from 1 to 30. Restrictions: The total number of proxy nodes for an instance is no more than 32.

  • Request example
{ 
  "node_num" : 2 
}

Response

  • Normal response
    Table 3 Parameter description

    Parameter

    Type

    Description

    job_id

    String

    Task ID.

    • Example normal response

    {

    "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"

    }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.