All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnBgpTrafficData

Last Updated:Mar 01, 2024

Queries traffic data for BGP accelerated domain names. Data is collected every 5 minutes.

Operation description

  • If you do not set the StartTime or EndTime parameter, the request returns the data collected in the last 24 hours. If you set both these parameters, the request returns the data collected within the specified time range. You must set both parameters or leave both parameters empty.
  • If you specify multiple Internet service providers (ISPs), the data for the ISPs is aggregated.
  • You can query data in the last 90 days.
  • The maximum time range that you can specify is 31 days. StartTime specifies the start time and EndTime specifies the end time of the time range.
  • If the time range from the start time to the end time is 72 hours or shorter, you can specify the interval as 5 minutes. If the time range is longer than 72 hours, you must specify the interval as 1 hour.
  • You can call this operation up to five times per second per account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dcdn:DescribeDcdnBgpTrafficDataRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IspstringNo

The ISP. Separate multiple ISPs with commas (,). If you specify multiple ISPs, the data for the ISPs is aggregated. If you do not specify this parameter, the operation returns the data for all the ISPs.

Valid values:

  • cu: China Unicom
  • cmi: China Mobile
  • ct: China Telecom
cu
StartTimestringNo

The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

The minimum data collection interval is an hour.

If you do not set this parameter, data collected in the last 24 hours is queried.

2018-11-29T00:00:00Z
EndTimestringNo

The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2018-11-30T00:00:00Z
IntervalstringNo

The data collection interval. Unit: seconds. Valid values: 300 and 3600. Default value: 300. The default value of 300 seconds is equal to 5 minutes. The value of this parameter varies based on the time range from the specified start time to the specified end time.

300

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

The end of the time range during which data was queried.

2018-11-30T00:00:00Z
StartTimestring

The start of the time range during which data was queried.

2018-11-29T00:00:00Z
RequestIdstring

The ID of the request.

E9D3257A-1B7C-414C-90C1-8D07AC47BCAC
BgpDataIntervalobject []

The BGP traffic at each time interval.

Outlong

The outbound traffic. Unit: bytes.

183
Inlong

The inbound traffic. Unit: bytes.

318
TimeStampstring

The timestamp of the data returned.

2018-11-29T20:00:00Z

Examples

Sample success responses

JSONformat

{
  "EndTime": "2018-11-30T00:00:00Z",
  "StartTime": "2018-11-29T00:00:00Z",
  "RequestId": "E9D3257A-1B7C-414C-90C1-8D07AC47BCAC",
  "BgpDataInterval": [
    {
      "Out": 183,
      "In": 318,
      "TimeStamp": "2018-11-29T20:00:00Z"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400MissingTimeParameterThe StartTime and EndTime must be both specified.You must set both the start time and the end time.
400InvalidStartTime.MalformedThe specified StartTime parameter is invalid.The format of the specified start time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400InvalidEndTime.MalformedThe specified EndTime is invalid.The format of the specified end time is invalid. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.The end time is earlier than the start time.
400InvalidStartTime.ValueNotSupportedThe specified StartTime is invalid.The specified start time is invalid.

For a list of error codes, visit the Service error codes.