All Products
Search
Document Center

Dynamic Content Delivery Network:DescribeDcdnDomainIpaTrafficData

Last Updated:Feb 19, 2024

Queries traffic of one or more accelerated domain names for which Layer 4 acceleration is enabled. You can query the data that is collected over the last 90 days.

Operation description

Note
  • 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 the StartTime and EndTime parameters, the request returns the data collected within the specified time range.

  • Unit: bytes.

  • You can call this operation up to 100 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:DescribeDcdnDomainIpaTrafficDataRead
  • IpaDomain
    acs:dcdn:*:{#accountId}:domain/{#domainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name.

Separate multiple domain names with commas (,). If you do not specify a value for this parameter, data for all accelerated domain names is queried.

example.com
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.

2017-12-10T20: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.

Note The end time must be later than the start time.
2017-12-10T21:00:00Z
TimeMergestringNo

Specifies whether to automatically calculate the value of the interval. If the timeMerge parameter is set to 1, the value of inteval is calculated based on StartTime and EndTime. You can set either this parameter or the interval parameter.

1
IntervalstringNo

The time granularity of data entries. Unit: seconds.

The time granularity varies with the time range specified by StartTime and EndTime.

  • If the time range between StartTime and EndTime is less than 3 days, the valid values are 300, 3600, and 86400. If you do not specify a value for this parameter, 300 is used.
  • If the time range between StartTime and EndTime is greater than or equal to 3 days and less than 31 days, the valid values are 3600 and 86400. Default value: 3600.
  • If the time range between StartTime and EndTime is 31 days or longer, the valid value is 86400. Default value: 86400.
300
FixTimeGapstringNo

Specify whether to implement padding with zeros. Valid values:

  • true
  • false
false
IspNameEnstringNo

The name of the Internet service provider (ISP).

You can call the DescribeDcdnRegionAndIsp operation to query ISPs.

unicom
LocationNameEnstringNo

The name of the region.

You can call the DescribeDcdnRegionAndIsp operation to query regions.

beijing

Response parameters

ParameterTypeDescriptionExample
object
EndTimestring

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

2017-12-10T21:00:00Z
StartTimestring

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

2017-12-10T20:00:00Z
RequestIdstring

The ID of the request.

B955107D-E658-4E77-B913-E0AC3D31693E
DomainNamestring

The accelerated domain name.

example.com
DataIntervalstring

The time interval between the data entries returned. Unit: seconds.

300
TrafficDataPerIntervalobject []

The network traffic that was collected at each interval.

IpaTrafficfloat

The total amount of network traffic.

423304182
TimeStampstring

The timestamp of the returned data.

2017-12-10T20:00:00Z

Examples

Sample success responses

JSONformat

{
  "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 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.