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

Creating Proxy Instance

Function

This API is used to create a proxy instance in ELB mode. Before calling this API:

This API will be unavailable on March 31, 2025. You are advised to switch workloads to the new API (Creating a Proxy Instance) 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

  • Example

    POST https://{endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/instances/c3ec2c6148ad4d71b1a8411a62df0d3cin07/proxy

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    Project ID of a tenant in a region.

    To obtain this value, see Obtaining a Project ID.

    instance_id

    Yes

    DB instance ID.

Request

Table 2 Parameter description

Name

Mandatory

Type

Description

flavor_ref

Yes

String

Proxy specification code.

node_num

Yes

Integer

Number of proxy instance nodes. It is an integer from 2 to 32.

  • Request example

    {

    " flavor_ref ":"gaussdb.mysql.large.x86.4",

    " node_num ":2

    }

Response

  • Normal response
    Table 3 Parameter description

    Name

    Type

    Description

    job_id

    String

    Job ID for creating a proxy instance.

    • Example normal response

      {

      " job_id ":"3a4ea53b-3c6c-4f88-9dd0-e21ed77b7e6a"

      }

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.