DescribeDcdnDomainUsageData-阿里云帮助中心

Queries the usage data of domain names in specific billing regions.

Operation description

Invoke frequency per user: 10 times per second.
Usage data includes three categories: traffic, bandwidth, and number of requests, measured in bytes, bit/s, and requests, respectively.

Supported time granularities for queries:

Depending on the maximum time span of a single query, the request parameter Interval supports different time granularities for queries. The corresponding time range of queryable historical data and data delay are as follows:

Time granularity	Maximum time span per query	Time range of queryable historical data	Data delay
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	Generally 3 to 4 hours
1 day	366 days	366 days	Generally 4 hours, up to 24 hours

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:DescribeDcdnDomainUsageData

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain names to query. You can query up to 100 domain names at a time. Separate multiple domain names with commas (,). Note If you do not specify this parameter, the merged data of all accelerated domain names is returned by default.	example.com
StartTime	string	Yes	The start time of the data 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 minimum time granularity for querying data is 5 minutes.	2015-12-10T20:00:00Z
EndTime	string	Yes	The end time of the data 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, and the time span cannot exceed 31 days.	2015-12-10T22:00:00Z
Field	string	Yes	The type of data to query. Valid values: bps: bandwidth. traf: traffic. acc: number of requests. Note acc does not support parameter query based on the Area parameter.	bps
Type	string	No	The type of requests. Valid values: static: static requests. dynamic: dynamic requests. all: all requests. Default value: all.	dynamic
DataProtocol	string	No	The protocol of the data to query. Valid values: quic: QUIC. https: HTTPS. http: HTTP. all: all the preceding protocols. Default value: all.	all
Area	string	No	The region code. Valid values: CN: the Chinese mainland. OverSeas: global (excluding 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 regions. Default value: CN.	CN
Interval	string	No	The time granularity of the data to query, in seconds. Depending on the maximum time span of a single query, this parameter supports the values 300 (5 minutes), 3600 (1 hour), and 86400 (1 day). For more information, see the supported time granularities for queries in the Usage notes section.	300

Parameter combinations

The following table describes the mappings between billing data and parameter values. For specific call methods, see the sample requests.

Billing data	DataProtocol value	Type value	Field value	Area value
Traffic	all or not specified	all or not specified	traf	CN OverSeas AP1 AP2 AP3 NA SA EU MEAA
Bandwidth	all or not specified	all or not specified	bps	CN OverSeas AP1 AP2 AP3 NA SA EU MEAA
Static HTTPS requests	https	static	acc	all
Dynamic HTTP requests	http	dynamic	acc	all
Dynamic HTTPS requests	https	dynamic	acc	all

Response elements

Element	Type	Description	Example
	object
DomainName	string	The queried accelerated domain name.	example.com
EndTime	string	The end time of the queried data. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2015-12-10T22:00:00Z
StartTime	string	The start time of the queried data. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2015-12-10T20:00:00Z
Type	string	The returned usage type.	bps
Area	string	The returned usage region.	CN
RequestId	string	The request ID.	B955107D-E658-4E77-B913-E0AC3D31693E
DataInterval	string	The time interval of each record, in seconds.	/
UsageDataPerInterval	object
DataModule	array<object>	The traffic data for each time interval.
	object
TimeStamp	string	The start time of the time slice. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2015-12-10T21:30:00Z
PeakTime	string	The time when the peak bandwidth was reached. This value is valid only when Field is set to bps. Otherwise, the value is the same as TimeStamp.	2015-12-10T21:30:00Z
Value	string	The usage.	4233041**
SpecialValue	string	The special usage. Note This parameter is used to mark the usage in special cases. You can ignore this parameter if no special billing is involved.	4233041**

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	A parameter is set to an invalid value.
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	InvalidTime.Malformed	Specified StartTime or EndTime is malformed.	The format of the specified start time or 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	InvalidParameterField	The specified Field is invalid.	The Field parameter is set to an invalid value.
400	InvalidParameterType	The specified Type is invalid.	The Type parameter is set to an invalid value.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Configure a valid time span as described in API documentation.
400	InvalidParameterInterval	The specified Interval is invalid.	The Interval parameter is set to an invalid value.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.