docs
api
Cloud Delivery(UCDN)
GetUcdnDomainHitRate

Get Domain Hit Rate (New) - GetUcdnDomainHitRate

Overview

Get domain hit rate

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUcdnDomainHitRate.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
TypeintTime granularity (0 represents a 5-minute granularity, 1 represents a 1-hour granularity, 2 represents a daily granularity, 3 represents a 1-minute granularity) default is 5 minutesYes
DomainId.NstringDomain ID, the ID generated when creating a domain. Default to all domains.No
AreacodestringThe query bandwidth area 'cn' represents domestic, 'abroad' represents overseas, only supports domestic.No
BeginTimeintThe start time of the query, formatted as Unix Timestamp. If there is an EndTime, BeginTime must be assigned. If not assigned, a missing parameter error will be returned. If there is no EndTime, BeginTime can also be unassigned. The default EndTime is the current time, and the default BeginTime is the current time of the previous day.No
EndTimeintThe end time of the query, in Unix Timestamp format. EndTime defaults to the current time, and BeginTime defaults to the time one day before the current time.No
HitTypeintThe default is 0No
IsDcdnbooleanIs acceleration enabled for the entire site, default is falseNo

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
HitRateListarray[HitRateInfoV2]Request number instance table.No

Data Model

HitRateInfoV2

Field NameTypeDescription InformationRequired
TimeintTime point for bandwidth acquisition. Format: TimestampNo
FlowHitRatefloatTotal traffic hit rate, unit %No
RequestHitRatefloatRequest hit rate, unit %No

Example

Request Example

https://api.surfercloud.com/?Action=GetUcdnDomainHitRate
&ProjectId=luMsAkgq
&Type=3
&DomainId.n=VNyehVPh
&Areacode=kFQcnVPx
&BeginTime=8
&EndTime=5
&HitType=8
&IsDcdn=true

Response Example

{
  "Action": "GetUcdnDomainHitRateResponse",
  "HitRateList": [
    {
      "EdgeFlowHitRate": 6.98827,
      "EdgeRequestHitRate": 4.11524,
      "FlowHitRate": 9.35869,
      "RequestHitRate": 4.64549,
      "Time": 5
    }
  ],
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved