Docs
api
Cloud Delivery(UCDN)
Get Ucdn Traffic

[To be taken offline] Retrieve traffic information - GetUcdnTraffic

Overview

Obtain Traffic Information

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUcdnTraffic.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
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, and the sub-account must be filled in. Please refer to the GetProjectList interface.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

http://api.dezai.com/?Action=GetUcdnTraffic
&ProjectId=xxxxx

Response Example

{
  "Action": "GetUcdnTrafficResponse",
  "RetCode": 0,
  "TrafficSet": [
    {
      "Areacode": "cn",
      "TrafficLeft": 100.1,
      "TrafficTotal": 120,
      "TrafficUsed": 19.9
    },
    {
      "Areacode": "abroad",
      "TrafficLeft": 100.1,
      "TrafficTotal": 120,
      "TrafficUsed": 19.9
    }
  ]
}