[To be taken offline] Retrieve traffic information - GetUcdnTraffic
Overview
Obtain Traffic Information
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is GetUcdnTraffic . | Yes |
PublicKey | string | The user’s public key can be obtained from Console | 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, and the sub-account must be filled in. Please refer to the GetProjectList interface. | 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 |
TrafficSet | array[TrafficSet] | Traffic information of users in different regions, see the TrafficSet section for specific structure. | No |
Data Model
TrafficSet
Field Name | Type | Description Information | Required |
---|---|---|---|
Areacode | string | Purchase traffic area, cn: Domestic; abroad: Overseas | No |
TrafficTotal | float | Total purchased traffic within Areacode area, unit GB | No |
TrafficLeft | float | Total remaining traffic within the Areacode area, unit GB | No |
TrafficUsed | float | Total usage traffic within the Areacode area, unit GB | No |
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
}
]
}