docs
api
Cloud Database(UDB)
GetUDBClientConnNum

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 NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUDBClientConnNum.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListYes
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
DBIdstringDB Instance idYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
DataSetarray[ConnNumMap]DB instance IP and connection count informationYes

Data Model

ConnNumMap

Field NameTypeDescription InformationRequired
IpstringClient IPNo
NumintThe number of connections for this IPNo

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
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved