Traffic: Get node bandwidth information

Request

Method Request URI
GET https://restapi.cdn.azure.cn/subscriptions/{subscriptionId}/endpoints/{endpointId}/bandwidth?apiVersion=1.0

URI parameter

</tr
Parameter name Description
subscriptionId Subscription unique identifier
endpointId Target node unique identifier
startTime Bandwidth query start time; UTC time in yyyy-MM-ddThh:mm:ssZ format
endTime Bandwidth query end time; UTC time in yyyy-MM-ddThh:mm:ssZ format

Request header

Request header Description
x-azurecdn-request-date Required.Enter the current UTC request time in yyyy-MM-dd hh:mm:ss format.
Authorization Required.Refer to CDN API signing mechanism for authorization headers.

Request body

None

Response

A response comprises a status code, response headers, and a response body.

Status code

Status code Description
200 Indicates that the server has returned a response successfully.
Other General response indicating that an error has occurred.

Response header

Response header Description
X-Correlation-Id The request’s unique identifier, which is used to track request information.

Response body

JSON example for request succeeded:

{
  "DomainName": "www.example.com",
  "Items": [
    {
      "Timestamp": "2017-05-02T00:00:00Z",
      "BandwidthInMbps": 100,
      "OriginBandwidthInMbps": 20
    ,
    {
      "Timestamp": "2017-05-02T00:00:05Z",
      "BandwidthInMbps": 80,
      "OriginBandwidthInMbps": 60
    },
    {
      "Timestamp": "2017-05-02T00:00:10Z",
      "BandwidthInMbps": 120,
      "OriginBandwidthInMbps": 10
    }
  ],
  "PeakBandwidthInMbps": 120,
  "ValleyBandwidthInMbps": 80,
  "PeakOriginBandwidthInMbps": 60,
  "ValleyOriginBandwidthInMbps": 10
}
Parameter name Description
PeakBandwidthInMbps CDN bandwidth peak value
ValleyBandwidthInMbps CDN bandwidth trough value
PeakOriginBandwidthInMbps Return-to-source bandwidth peak value
ValleyBandwidthInMbps Return-to-source bandwidth trough value

JSON example for request failed:

{
  "Succeeded": false,
  "ErrorInfo": {
    "Type": "MissingAuthorizationHeader",
    "Message": "Missing authorization header."
  }
}
Parameter name Description
Type Error type
  • CredentialInvalid: Invalid credentials
  • ParameterMissing: Parameter missing
  • ParameterInvalid: Invalid parameter
  • MissingAuthorizationHeader: Authorization header missing
  • InvalidRequestDateHeader: Invalid request date header
  • MissingRequestDateHeader: Missing request date header
  • AuthorizationHeaderExpired: Authorization header expired
  • InvalidAuthorizationHeader: Invalid authorization header
  • ApiKeyNotFound: API key not found
  • InvalidApiKey: Invalid API key
  • WrongSignature: Wrong signature
  • SubscriptionNotFound: Subscription does not exist
  • EndpointDoesNotBelongToSubscription: Endpoint does not belong to subscription
  • EndpointNotInActiveState: Endpoint not in active state
  • EndpointNotFound: Endpoint does not exist
  • MaliciousItemPathDetected: Malicious item path detected
  • PermissionDenied: Insufficient permissions
  • RequestThrottled: Request throttled

Message Error information