Docs
api
Cloud Delivery(UCDN)
GetUcdnProIspBandwidthV2

Obtain domain bandwidth data by province and operator [New] - GetUcdnProIspBandwidthV2

Overview

Obtain domain bandwidth data by province and operator

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUcdnProIspBandwidthV2.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, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
BeginTimeintThe start date of the query, in Unix Timestamp format.Yes
EndTimeintThe end date of the query, in Unix Timestamp format.Yes
TypeintTime Granularity
0 (By 5-minute granularity)
1 (By hour granularity)
2 (By day granularity)
3 (By minute granularity)
Yes
DomainId.NstringDomain ID, the ID generated when creating a domain. Default to all domains.No
Province.NstringProvince code (province pinyin), multiple can be passed, if not passed, all provinces will be queried.No
IspstringCarrier code (carrier pinyin), only one carrier can be queried at a time, if not passed, all carriers will be taken by default.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
BandwidthSetarray[ProIspBandwidthSet]Bandwidth traffic instance table by province. Refer to the following BandwidthSet.Yes

Data Model

ProIspBandwidthSet

Field NameTypeDescription InformationRequired
ProvincestringProvince CodeYes
BandwidthTrafficListarray[ProIspBandwidthList]Provincial Bandwidth Traffic Instance TableYes

ProIspBandwidthList

Field NameTypeDescription InformationRequired
TimeintTime point for bandwidth acquisition. Format: TimestampNo
CdnBandwidthfloatReturns the peak bandwidth of CDN within the specified time interval, unit MbpsNo
TrafficfloatTraffic corresponding to the time granularity, unit in bytesNo

Example

Request Example

https://api.dezai.com/?Action=GetUcdnProIspBandwidthV2
&ProjectId=ZjPtoiWU
&BeginTime=4
&EndTime=9
&Type=6
&DomainId.n=SNEulleF
&Province.n=shanghai
&Isp=dianxin

Response Example

{
  "Action": "GetUcdnProIspBandwidthV2Response",
  "BandwidthSet": [
    {
      "BandwidthList": [
        {
          "CdnBandwidth": 3.79748,
          "Time": 5
        }
      ],
      "Province": "xIjRHOXf"
    }
  ],
  "RetCode": 0
}