DescribeDcdnDomainIpaTrafficData - Edge Security Acceleration

Operation description

Note

If you do not specify the StartTime and EndTime parameters, data from the last 24 hours is returned. If you specify both parameters, data in the specified time range is returned.
The data is measured in bytes.
The call frequency for a single user is 100 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:DescribeDcdnDomainIpaTrafficData

get

*IpaDomain

acs:dcdn:*:{#accountId}:domain/{#domainName}

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain name. Separate multiple domain names with commas (,). If you do not specify this parameter, data for all accelerated domain names is queried.	example.com
StartTime	string	No	The beginning of the time range to query. Specify the time in the ISO 8601 standard. The time must be in UTC. Format: yyyy-MM-ddTHH:mm:ssZ.	2017-12-10T20:00:00Z
EndTime	string	No	The end of the time range to query. Specify the time in the ISO 8601 standard. The time must be in UTC. Format: yyyy-MM-ddTHH:mm:ssZ. Note The end time must be later than the start time.	2017-12-10T21:00:00Z
TimeMerge	string	No	Specifies whether to automatically calculate the time granularity. If you set this parameter to 1, the system calculates a proper value for the Interval parameter based on the specified time range. You can specify either TimeMerge or Interval.	1
Interval	string	No	The time granularity of the data to query. Unit: seconds. The value of this parameter depends on the time range specified by the StartTime and EndTime parameters: If the time span is less than 3 days: 300, 3600, and 86400. If you do not set this parameter, the default value is 300. If the time span is from 3 to 31 days (not including 31 days): 3600 and 86400. If you do not set this parameter, the default value is 3600. If the time span is 31 days or more: 86400. If you do not set this parameter, the default value is 86400.	300
FixTimeGap	string	No	Specifies whether to pad data with zeros. Valid values: true: Pads data with zeros. false: Does not pad data with zeros.	false
IspNameEn	string	No	The name of the carrier. You can call the DescribeDcdnRegionAndIsp operation to query the names of carriers. If you do not specify this parameter, data for all carriers is queried.	unicom
LocationNameEn	string	No	The name of the region. You can call the DescribeDcdnRegionAndIsp operation to query the names of regions. If you do not specify this parameter, data for all regions is queried.	beijing

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range.	2017-12-10T21:00:00Z
StartTime	string	The start of the time range.	2017-12-10T20:00:00Z
RequestId	string	The request ID.	B955107D-E658-4E77-B913-E0AC3D31693E
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between data records, in seconds.	300
TrafficDataPerInterval	object
DataModule	array<object>	The traffic data for each time interval.
	object
IpaTraffic	number	The total traffic.	423304182
TimeStamp	string	The timestamp of the data point.	2017-12-10T20:00:00Z

Examples

Success response

JSON format

{
  "EndTime": "2017-12-10T21:00:00Z",
  "StartTime": "2017-12-10T20:00:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "DataInterval": "300",
  "TrafficDataPerInterval": {
    "DataModule": [
      {
        "IpaTraffic": 423304182,
        "TimeStamp": "2017-12-10T20: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.