Get connection instance client IP and number of connections - GetUDBClientConnNum
Overview
Enter a DBID to obtain the source IP of the client and the corresponding number of connections.
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetUDBClientConnNum . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
Zone | string | Availability Zone. See Availability Zone List | Yes |
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
DBId | string | DB Instance id | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
DataSet | array[ConnNumMap] | DB instance IP and connection count information | Yes |
Data Model
ConnNumMap
Field Name | Type | Description Information | Required |
---|---|---|---|
Ip | string | Client IP | No |
Num | int | The number of connections for this IP | No |
Example
Request Example
https://api.surfercloud.com/?Action=GetUDBClientConnNum
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=clkPraZH
&DBId=udb-xxxxxxx
Response Example
{
"Action": "GetUDBClientConnNumResponse",
"DataSet": [
{
"Ip": "172.xx.xx.xx",
"Num": 3
}
],
"RetCode": 0
}