All Products
Search
Document Center

CDN:DescribeDomainUsageData

Last Updated:Mar 28, 2024

Queries the resource usage data of specific domain names in a specified billable region.

Operation description

  • You can call this operation up to 10 times per second per account.
  • The time granularity supported by the Interval parameter, the maximum time period within which historical data is available, and the data delay vary with the maximum time range per query, as described in the following table.
Time granularityMaximum time range per queryHistorical data availableData delay
5 minutes3 days93 days15 minutes
1 hour31 days186 days4 hours
1 day90 days366 days04:00 on the next day

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
cdn:DescribeDomainUsageDataREAD
  • Domain
    acs:cdn:*:{#accountId}:domain/{#DomainName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DomainNamestringNo

The accelerated domain name. You can specify up to 100 domain names in each request. Separate multiple domain names with commas (,).

Note If you leave this parameter empty, the usage data of all accelerated domain names in your Alibaba Cloud account is returned.
example.com
StartTimestringYes

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.

Note Data is collected every 5 minutes.
2015-12-10T20:00:00Z
EndTimestringYes

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. The maximum time range that can be specified is 31 days.
2015-12-10T22:00:00Z
FieldstringYes

The type of the data that you want to query. Valid values:

  • bps: bandwidth
  • traf: traffic
  • acc: requests
Note If you set this parameter to acc, the Area parameter is not supported.
bps
TypestringNo

The type of content that you want to query. Valid values:

  • static: static content
  • dynamic: dynamic content
  • all (default): both static and dynamic content
static
DataProtocolstringNo

The protocol of the data that you want to query. Valid values:

  • http: HTTP
  • https: HTTPS
  • quic: QUIC
  • all (default): HTTP, HTTPS, and QUIC
all
AreastringNo

The billable region. Valid values:

  • CN (default): inside the Chinese mainland
  • OverSeas: outside the Chinese mainland
  • AP1: Asia Pacific 1
  • AP2: Asia Pacific 2
  • AP3: Asia Pacific 3
  • NA: North America
  • SA: South America
  • EU: Europe
  • MEAA: Middle East and Africa
  • all: all the preceding billable regions
CN
IntervalstringNo

The time granularity of the data entries. Unit: seconds. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day).

  • If Interval is set to 300, you can query usage data in the last 6 months. The maximum time range per query that can be specified is 3 days.
  • If Interval is set to 3600 or 86400, you can query usage data of the previous year.
  • If you leave the Interval parameter empty, the maximum time range that you can query is 1 month. If you specify a time range of 1 to 3 days, the time interval between the entries that are returned is 1 hour. If you specify a time range of at least 4 days, the time interval between the entries that are returned is 1 day.
300

Billable items and parameters

The following table describes the parameters of each billable item. For more information about how to call relevant operations, see the sample requests.

Billable itemValid value of DataProtocolValid value of TypeValid value of FieldValid value of Area
Data transferall or no valueall or no valuetrafCN, OverSeas, AP1, AP2, AP3, NA, SA, EU, and MEAA
Bandwidthall or no valueall or no valuebpsCN, OverSeas, AP1, AP2, AP3, NA, SA, EU, and MEAA
HTTPS requests for static contenthttpsstaticaccall
HTTP requests for dynamic contenthttpdynamicaccall
HTTPS requests for dynamic contenthttpsdynamicaccall
QUIC requests for dynamic contentquicdynamicaccall
QUIC requests for static contentquicstaticaccall

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

B955107D-E658-4E77-B913-E0AC3D31693E
DomainNamestring

The accelerated domain name.

example.com
StartTimestring

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

2015-12-10T20:00:00Z
EndTimestring

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

2015-12-10T22:00:00Z
Typestring

The type of content.

static
Areastring

The ID of the billable region where the data was collected.

CN
DataIntervalstring

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

300
UsageDataPerIntervalobject []

The resource usage that was collected at each interval.

Valuestring

The amount of resource usage.

423304182
TimeStampstring

The timestamp of the data returned.

Note TimeStamp indicates the timestamp of the data returned at each interval.
2015-12-10T21:30:00Z
PeakTimestring

The time of the peak bandwidth value if the Field parameter in the request is set to bps. Otherwise, this parameter returns the same value as the TimeStamp parameter.

2015-12-10T21:30:00Z
SpecialValuestring

The resource usage in a specific scenario.

Note SpecialValue indicates the data usage in a specific scenario. If no special billable item is specified, ignore this parameter.
423304182

Examples

Sample success responses

JSONformat

{
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DomainName": "example.com",
  "StartTime": "2015-12-10T20:00:00Z",
  "EndTime": "2015-12-10T22:00:00Z",
  "Type": "static",
  "Area": "CN",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "423304182",
        "TimeStamp": "2015-12-10T21:30:00Z",
        "PeakTime": "2015-12-10T21:30:00Z",
        "SpecialValue": "423304182"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe specified parameter is invalid.-
400InvalidParameterProductInvalid Parameter Product.The Product parameter is set to an invalid value.
400InvalidParameterTypeThe specified Type is invalid.The Type parameter is set to an invalid value.
400InvalidParameterFieldThe specified Field is invalid.The Field parameter is set to an invalid value.
400InvalidParameterStartTimeThe parameter StartTime is invalid.The specified StartTime parameter is invalid.
400InvalidParameterEndTimeThe parameter EndTime is invalid.-
400InvalidEndTime.MismatchSpecified EndTime does not match the specified StartTime.StartTime must be earlier than EndTime.
400InvalidIntervalParameterThe specified Interval is invalid.The specified time interval is invalid.
400InvalidTimeSpanThe time span exceeds the limit.The time span exceeds the limit. Configure a valid time span as described in API documentation.
400InvalidStartTime.ValueNotSupportedThe specified value of parameter StartTime is not supported.The start time is invalid. Set this parameter to another value and try again.

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

Change history

Change timeSummary of changesOperation
2023-06-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-03-16The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400