Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to query the database proxy list.
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: DescribeProxies. |
| 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 | No | String | Cluster ID (this parameter is required, for example, cynosdbmysql-2u2mh111). |
| Limit | No | Integer | Number of returns. Default value: 20. Maximum value: 100 |
| Offset | No | Integer | Record offset. Default value: 0 |
| OrderBy | No | String | Sorting field. Value range: |
| OrderByType | No | String | Sorting type. Value range: |
| Filters.N | No | Array of QueryParamFilter | Search criteria. If there are multiple Filters, the relationship between them is logical AND. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of Database Proxy Groups |
| ProxyGroupInfos | Array of ProxyGroupInfo | Database Proxy Group list |
| ProxyNodeInfos | Array of ProxyNodeInfo | Database proxy node |
| ColumnStoreProxyForward | String | sql automatic forwarding |
| 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. |
Query a database proxy
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProxies
<Common request parameters>
{
"OrderBy": "createTime",
"ClusterId": "cynosdbmysql-xx",
"Limit": 0,
"Filters": [
{
"Values": [
"proxyGroupId"
],
"Names": [
"cynosdbmysql-proxy-tshj6btw"
],
"ExactMatch": true
}
],
"Offset": 0,
"OrderByType": "desc"
}{
"Response": {
"TotalCount": 2,
"ProxyGroupInfos": [
{
"ConnectionPool": {
"ConnectionPoolTimeOut": 30,
"ConnectionPoolType": "SessionConnectionPool",
"OpenConnectionPool": "yes"
},
"NetAddrInfos": [
{
"Description": "external-ro new",
"InstanceGroupId": "cynosdbmysql-grp-nsiuj4aj",
"NetType": "",
"UniqSubnetId": "subnet-pmqqss72",
"UniqVpcId": "vpc-gvelzo5j",
"Vip": "11.2.1.43",
"Vport": 3306,
"WanDomain": "test.wan.domain",
"WanIP": "11.2.3.43",
"WanPort": 3306,
"WanStatus": "open"
}
],
"ProxyGroup": {
"AppId": 1772344699,
"ClusterId": "cynosdbmysql-i2weamox",
"CurrentProxyVersion": "1.3.11",
"OpenRw": "yes",
"ProxyGroupId": "cynosdbmysql-proxy-mdhg55su",
"ProxyNodeCount": 4,
"Region": "ap-guangzhou",
"Status": "running",
"Zone": "ap-guangzhou-6"
},
"ProxyGroupRwInfo": {
"AccessMode": "balance",
"AutoAddRo": "no",
"ConsistencyTimeOut": 0,
"ConsistencyType": "eventual",
"FailOver": "no",
"InstanceWeights": [
{
"InstanceId": "cynosdbmysql-ins-ka2i3m48",
"Weight": 1
}
],
"OpenRw": "yes",
"RwType": "READONLY",
"TransSplit": false,
"WeightMode": "system"
},
"ProxyNodes": [
{
"AppId": 1772344699,
"ClusterId": "cynosdbmysql-i2weamox",
"Cpu": 2,
"Mem": 4000,
"OssProxyNodeName": "cynosdbmysql-proxyNode-q52v1wp4",
"ProxyGroupId": "cynosdbmysql-proxy-mdhg57su",
"ProxyNodeConnections": 157,
"ProxyNodeId": "cynosdbmysql-proxyNode-pv4hg4na",
"Region": "ap-guangzhou",
"Status": "running",
"Zone": "ap-guangzhou-6"
}
],
"Tasks": [
{
"TaskId": 123124,
"TaskType": "taskModifyProxyRwSplit",
"TaskStatus": "processing",
"ObjectId": "cynosdbmysql-proxy-mdhg57su",
"ObjectType": "taskObjTypeCluster"
}
]
}
],
"ProxyNodeInfos": [
{
"ProxyNodeId": "cynosdbmysql-proxyNode-pv4hg4na",
"ProxyNodeConnections": 157,
"Cpu": 2,
"Mem": 4000,
"Status": "running",
"ProxyGroupId": "cynosdbmysql-proxy-mdhg57su",
"ClusterId": "cynosdbmysql-i2weamox",
"AppId": 1772344699,
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-6",
"OssProxyNodeName": "cynosdbmysql-proxyNode-q52v1wp4"
}
],
"RequestId": "ed0bd4ca-b5c0-4230-a8b5-6d2dc5ec1eb0"
}
}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.CamCheckResourceError | Failed to obtain permissions. Try again later. If the issue persists, contact customer service. |
| FailedOperation.DatabaseAccessError | Database access failed. Try again later. If the issue persists, contact customer service. |
| FailedOperation.OperationFailedError | Operation failed. Try again later. If the issue persists, contact customer service. |
| InternalError.DbOperationFailed | Query database failed. |
| InternalError.SystemError | Internal system error. |
| InvalidParameterValue.IllegalOrderBy | Invalid sorting field. |
| InvalidParameterValue.InvalidParameterValueError | Parameter value is invalid. |
| InvalidParameterValue.ParamBothSetError | Both parameters cannot be set simultaneously. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
文档反馈