docs
api
Cloud Delivery(UCDN)
GetUcdnTrafficV2

Get Total Account Traffic Information [New] - GetUcdnTrafficV2

Overview

Obtain Traffic Information

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUcdnTrafficV2.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
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
IsDcdnbooleanIs it a DCDN domain?No

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
TrafficSetarray[TrafficSet]Traffic information of users in different regions, see the TrafficSet section for specific structure.No

Data Model

TrafficSet

Field NameTypeDescription InformationRequired
AreacodestringPurchase traffic area, cn: Domestic; abroad: OverseasNo
TrafficTotalfloatTotal purchased traffic within Areacode area, unit GBNo
TrafficLeftfloatTotal remaining traffic within the Areacode area, unit GBNo
TrafficUsedfloatTotal usage traffic within the Areacode area, unit GBNo

Example

Request Example

https://api.surfercloud.com/?Action=GetUcdnTrafficV2
&ProjectId=KZYWwtxi
&IsDcdn=false

Response Example

{
  "Action": "GetUcdnTrafficV2Response",
  "RetCode": 0,
  "TrafficSet": [
    {
      "Areacode": "hsQSdMju",
      "TrafficLeft": 7.91123,
      "TrafficTotal": 1.41679,
      "TrafficUsed": 7.32748
    }
  ]
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved