14 KiB
Disabling Database Proxy
Function
This API is used to disable database proxy. Before using this API:
- Learn how to authorize and authenticate it.
- Obtain the required region and endpoint.
- Database proxy is unavailable for DB instances in a DeC.
URI
DELETE /v3/{project_id}/instances/{instance_id}/proxy
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 |
DB instance ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. |
X-Language |
No |
String |
Language. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
proxy_ids |
No |
Array of strings |
Proxy instance IDs. If only one proxy instance is created, this parameter is not required. If multiple proxy instances are created, this parameter must be specified. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Task ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Request
DELETE https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07/proxy { "proxy_ids" : [ "151c14381ac14ecfb9703a745b992677po01" ] }
Example Response
Status code: 200
Success.
{ "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890" }
Status Code
For details, see Status Codes.
Error Code
For details, see Error Codes.