This API will be disused soon.
Planned disuse time: 2023-07-17 20:42:16
Domain name for API request: cdb.tencentcloudapi.com.
This API is deprecated and replaced by the DescribeCdbProxyInfo
API.
This API is used to query database proxy. It will be deprecated and replaced by the QueryCDBProxy
API.
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: DescribeCDBProxy. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Instance ID |
ProxyGroupId | No | String | Proxy group ID |
Parameter Name | Type | Description |
---|---|---|
BaseGroup | BaseGroupInfo | Basic information of the proxy group Note: this field may return null , indicating that no valid value can be found. |
Address | Address | Address information of the proxy group Note: this field may return null , indicating that no valid value can be found. |
ProxyNode | ProxyNodeInfo | Node information of the proxy group Note: this field may return null , indicating that no valid value can be found. |
RWInstInfo | RWInfo | Read/Write separation information Note: this field may return null , indicating that no valid value can be found. |
ConnectionPoolInfo | ConnectionPoolInfo | Connection pool information Note: this field may return null , indicating that no valid value can be found. |
Count | Integer | Number of instances in the proxy group Note: this field may return null , indicating that no valid value can be found. |
ProxyGroup | Array of ProxyGroup | Proxy information Note: this field may return null , indicating that no valid value can be found. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCDBProxy
<Common request parameters>
{
"InstanceId": "xx",
"ProxyGroupId": "xx"
}
{
"Response": {
"Count": 1,
"RWInstInfo": {
"MaxDelay": 1,
"AutoAddRo": true,
"IsKickOut": true,
"FailOver": true,
"RWInstInfo": {},
"MinCount": 1,
"WeightMode": "xx",
"InstCount": 1
},
"ProxyNode": {
"ProxyNodeId": "xx",
"ProxyNodeMem": 1,
"ProxyNodeConnections": 1,
"ProxyNodeCpu": 1,
"ProxyStatus": "xx"
},
"ConnectionPoolInfo": {
"ConnectionPoolType": "xx",
"PoolConnectionTimeOut": 0,
"ConnectionPool": true
},
"RequestId": "xx",
"Address": {
"UniqVpcId": "xx",
"VPort": 1,
"Vip": "xx",
"UniqSubnet": "xx",
"Desc": "xx"
},
"ProxyGroup": [
{
"ConnectionPoolInfo": {
"ConnectionPoolType": "xx",
"PoolConnectionTimeOut": 0,
"ConnectionPool": false
},
"RWInstInfo": {
"MaxDelay": 1,
"AutoAddRo": true,
"IsKickOut": true,
"FailOver": true,
"RWInstInfo": {},
"MinCount": 1,
"WeightMode": "xx",
"InstCount": 1
},
"BaseGroup": {
"Status": "xx",
"CurrentProxyVersion": "xx",
"ProxyGroupId": "xx",
"Zone": "xx",
"Region": "xx",
"NodeCount": 1,
"SupportUpgradeProxyVersion": "xx",
"OpenRW": true
},
"ProxyNode": {
"ProxyNodeId": "xx",
"ProxyNodeMem": 1,
"ProxyNodeConnections": 1,
"ProxyNodeCpu": 1,
"ProxyStatus": "xx"
},
"Address": {
"UniqVpcId": "xx",
"VPort": 1,
"Vip": "xx",
"UniqSubnet": "xx",
"Desc": "xx"
}
}
],
"BaseGroup": {
"Status": "xx",
"CurrentProxyVersion": "xx",
"ProxyGroupId": "xx",
"Zone": "xx",
"Region": "xx",
"NodeCount": 1,
"SupportUpgradeProxyVersion": "xx",
"OpenRW": true
}
}
}
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.DescribeProxyGroupError | Failed to query database proxy. |
InternalError.DBRecordNotExistError | The database record does not exist. |
InternalError.InternalHttpServerError | An exception occurred while executing the request. |
InternalError.UnknownError | Unknown error |
Was this page helpful?