[To be offline] Obtain back-to-source bandwidth data (classified by time) - GetUcdnPassBandwidth
Overview
Retrieve back-to-source bandwidth data (CDN back to customer source part)
💡 This interface is about to be deprecated, to get the domain name request number, please use the latest interface GetUcdnPassBandwidthV2.
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetUcdnPassBandwidth . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | No |
Type | int | Time granularity (0 represents a granularity of 5 minutes, 1 represents a granularity of 1 hour, 2 represents a granularity of one day) | Yes |
DomainId.N | string | Domain ID, the ID generated when creating a domain. Default to all domains. | No |
Areacode | string | The query bandwidth area 'cn' represents domestic, 'abroad' represents overseas, only supports domestic. | No |
BeginTime | int | The 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 |
EndTime | int | The 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 |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
BandwidthDetail | array[BandwidthInfoDetail] | Back-to-source Bandwidth Data | No |
Data Model
BandwidthInfoDetail
Field Name | Type | Description Information | Required |
---|---|---|---|
Time | int | Time point of bandwidth acquisition. Format: Timestamp | Yes |
Bandwidth | float | Return bandwidth value data. | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=GetUcdnPassBandwidth
&ProjectId=uFxeLekv
&Type=4
&DomainId.n=EFBocqQR
&Areacode=ZWFUlCEE
&BeginTime=9
&EndTime=1
Response Example
{
"Action": "GetUcdnPassBandwidthResponse",
"BandwidthDetail": [
{
"Bandwidth": 5.42314,
"Time": 1
}
],
"RetCode": 0
}