Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query the details of a database proxy.
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: DescribeCdbProxyInfo. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
InstanceId | Yes | String | Instance ID |
ProxyGroupId | No | String | Proxy group ID |
Parameter Name | Type | Description |
---|---|---|
Count | Integer | Number of proxy groups Note: This field may return null, indicating that no valid values can be obtained. |
ProxyInfos | Array of ProxyGroupInfo | Proxy group information Note: This field may return null, indicating that no valid values can be obtained. |
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 query the proxy information.
POST / HTTP/1.1Host: cdb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeCdbProxyInfo<common request parameters>{ "InstanceId": "cdb-aykuksx3"}
{ "Response": { "Count": 1, "ProxyInfos": [ { "ConnectionPoolLimit": 5, "ProxyAddress": [ { "AutoAddRo": true, "ConnectionPool": false, "Desc": "", "FailOver": true, "IsKickOut": false, "MaxDelay": 0, "MinCount": 0, "ProxyAddressId": "", "FailOver": true, "IsKickOut": false, "MaxDelay": 0, "MinCount": 0, "ProxyAddressId": "cdb-test", "InstanceName": "Test", "InstanceType": "1", "Region": "ap-nanjing", "Status": 1, "Weight": 0, "Zone": "p-nanjing-1" } ], "Region": "ap-nanjing", "Zone": "ap-nanjing-1" } ], "ReadOnly": false, "TransSplit": false, "UniqSubnetId": "subnet-test", "UniqVpcId": "vpc-test", "VPort": 3306, "Vip": "10.0.0.0", "WeightMode": "custom" } ], "ProxyGroupId": "proxy-mfxftest", "ProxyNode": [ { "Cpu": 2, "Mem": 4000, "ProxyId": "proxynode-test", "Region": "ap-nanjing", "Status": "online", "Zone": "ap-nanjing-1", "Connection": 1 } ], "ProxyVersion": "1.3.7", "Status": "online", "SupportCreateProxyAddress": false, "SupportUpgradeProxyMysqlVersion": "20211030", "SupportUpgradeProxyVersion": "1.3.7", "TaskStatus": "ProxyModifyAddress" } ], "RequestId": "69d4c061-9730-4e2f-btttbb2-a74624bc9a6c" }}
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.HttpError | Exceptional HTTP request |
InternalError.InternalHttpServerError | An exception occurred while executing the request. |
InternalError.UnknownError | Unknown error |
InvalidParameter.ControllerNotFoundError | This API was not found. |
Was this page helpful?