产品动态
产品公告
Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to close the database proxy service of a cluster.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CloseProxy. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| ClusterId | Yes | String | Cluster ID |
| ProxyGroupId | No | String | Database proxy group ID |
| OnlyCloseRW | No | Boolean | Whether only to disable read/write separation. Valid values: true, false. |
| Parameter Name | Type | Description |
|---|---|---|
| FlowId | Integer | Async flow ID |
| TaskId | Integer | Async task ID |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to disable the database proxy.
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CloseProxy
<Common request parameters>
{
"ClusterId": "cynosdbmysql-mwg7212w",
"ProxyGroupId": "cynosdbmysql-proxy-4378e0ky",
"OnlyCloseRW": true
}{
"Response": {
"FlowId": 358874,
"TaskId": 1063084,
"RequestId": "e4f4f48a-51b1-45be-a9e3-09f0d1412659"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed |
| FailedOperation.DatabaseAccessError | Failed to access the database. Please try again later. If the problem persists, please contact customer service. |
| FailedOperation.FlowCreateError | Failed to create a task. Try again later. If the problem persists, contact customer service. |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the problem persists, contact customer service. |
| InternalError.InternalHttpServerError | An exception occurred while executing the HTTP request. |
| InvalidParameterValue.InvalidParameterValueError | Invalid parameter value. |
| OperationDenied.InstanceStatusDeniedError | For the instance in this status, the operation is not allowed. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
文档反馈