DescribeDcdnBgpBpsData - Edge Security Acceleration - Alibaba Cloud Documentation Center

Operation description

If you do not specify `StartTime` and `EndTime`, the operation retrieves data from the past 24 hours by default. You can also specify both `StartTime` and `EndTime` to query data for a specific time range.
If you specify multiple lines, the data is aggregated.
You can query data from the last 90 days.
The maximum time span between `StartTime` and `EndTime` is 31 days.
If the time span is 72 hours or less, the data is returned at a 5-minute granularity. If the time span is more than 72 hours, the data is returned at an hourly granularity.
The maximum call frequency for a single user is 5 calls per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dcdn:DescribeDcdnBgpBpsData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Isp	string	No	The line to query. To query multiple lines, separate them with commas (,). If you specify multiple lines, the data is aggregated. By default, data for all lines is queried. Valid values: cu: China Unicom. cmi: China Mobile. ct: China Telecom.	cu
StartTime	string	No	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 granularity is 1 hour. By default, data from the past 24 hours is read.	2018-11-29T00:00:00Z
EndTime	string	No	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
Interval	string	No	The data granularity in seconds. Valid values are 300 and 3600. The default value is 300 (five minutes). The final granularity also depends on the specified time span.	300
DeviceName	string	No	The device name. If you specify a device name, data for that device is returned. If you do not specify a device name, data for all devices is merged and returned.	devicename
DevicePort	string	No	The device port. If you specify a port, data for that port is returned. If you do not specify a port, data for all ports is returned. This parameter takes effect only when you specify DeviceName.	123

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range.	2018-11-30T00:00:00Z
StartTime	string	The beginning of the time range.	2018-11-29T00:00:00Z
RequestId	string	The request ID.	E9D3257A-1B7C-414C-90C1-8D07AC47BCAC
BgpDataInterval	array<object>	The BGP bandwidth data for each time interval.
	object
Out	number	The outbound bandwidth. Unit: Bps.	183
In	number	The inbound bandwidth. Unit: Bps.	318
TimeStamp	string	The start time of the time slice.	2018-11-29T20:00:00Z

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
400	InvalidStartTime.Malformed	The 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.
400	InvalidEndTime.Malformed	The 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.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.