Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Database Proxy/ Modifying the Name of a Proxy Instance
Updated on 2024-09-11 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying the Name of a Proxy Instance

Function

This API is used to modify the name of a proxy instance. Before calling this API:

URI

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

Table 1 URI parameters

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.

proxy_id

Yes

String

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Content type. Value: application/json

X-Auth-Token

Yes

String

User token.

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

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

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

alias

Yes

String

New name of the proxy instance.

Response Parameters

Status code: 200

Table 4 Response body parameter

Parameter

Type

Description

result

String

The modification is successful or fails.

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

Modifying the name of a proxy instance

PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/4785fc80386846f3ad2bf4e0cd53a4cein07/proxy/286a4a1a45e3400c907b51b0721377f9po01/rename

{
  "alias" : "newName"
}

Example Response

Status code: 200

Success.

{
  "result" : "success"
}

Status Code

Status Code

Description

200

Success.

400

Clinet error.

500

Server error.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy