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

Rebooting a Proxy Instance

Function

This API is used to reboot a proxy instance. Before calling this API:

URI

POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/restart

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.

proxy_id

Yes

String

Proxy instance ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

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.

Content-Type

Yes

String

Content type.

Value: application/json

X-Language

No

String

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

Values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 3 Response body parameter

Parameter

Type

Description

job_id

String

Workflow ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Rebooting a proxy instance

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/151c14381ac14ecfb9703a745b992677po01/restart

Example Response

Status code: 200

Success.

{
  "job_id" : "dff1d289-4d03-4942-854f-463ea07c000d"
}

Status Code

Status Code

Description

200

Success.

400

Client error.

500

Server error.

Error Code

For details, see Error Codes.

Parent topic: Database Proxy