Call DescribeDomainPathData to query network traffic and visits by directory - CDN

Operation description

This operation is available only to users that are on the whitelist. If the daily peak bandwidth value of your workloads reaches 10 Gbit/s, you can submit a ticket to apply to be included in the whitelist.
Each account can call this operation up to 6,000 times per second.
Data collection by directory is available only to specified domain names within your Alibaba Cloud account. It cannot be enabled for all domain names within your Alibaba Cloud account.
The average size of the files that belong to the domain name must be larger than 1 MB.
The number of directories specified for a single domain name cannot exceed 100. If the number of directories exceeds 100, the data accuracy reduces.
If you do not set StartTime or EndTime, data collected within the last 24 hours is queried. If you set both StartTime and EndTime, data within the specified time range is queried.
You can query data collected within the last 30 days.

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

cdn:DescribeDomainPathData

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The number of the page to return. Pages start from page 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: integers from 1 to 1000.	20
Path	string	No	The paths that you want to query. Separate paths with forward slashes (/). If you do not set this parameter, all paths are queried. If you set the value to a directory, it must end with a forward slash (/). Note Fuzzy match is not supported. If you want data to be collected based on a directory, you can specify a specific directory, for example, directory/path/. In this case, bandwidth data is collected based on directory/path/.	/path/
StartTime	string	No	Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Example: 2016-10-20T04:00:00Z.	2016-10-20T04: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. The interval between the start time and end time must be less than 30 days. Example: 2016-10-21T04:00:00Z.	2016-10-21T04:00:00Z
DomainName	string	Yes	The accelerated domain name. Note You can specify only one domain name in each call.	example.com

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range during which data was queried.	2017-09-30T17:00:00Z
StartTime	string	The start of the time range during which data was queried.	2017-09-30T16:00:00Z
PageSize	integer	The number of entries returned per page.	20
PageNumber	integer	The page number of the returned page. Pages start from page 1.	1
TotalCount	integer	The total number of entries returned.	2
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval. Unit: seconds.	300
PathDataPerInterval	object
UsageData	array<object>	A list of bandwidth values collected at each time interval.
	object
Path	string	The path.	/path/
Time	string	The point in time.	2017-09-30T16:00:00Z
Acc	integer	The number of visits to the URL.	10
Traffic	integer	The amount of network traffic. Unit: bytes.	346
RequestId	string	The ID of the request.	809A6F10-8238-4A49-BE00-4B2D6305686E

Examples

Success response

JSON format

{
  "EndTime": "2017-09-30T17:00:00Z",
  "StartTime": "2017-09-30T16:00:00Z",
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 2,
  "DomainName": "example.com",
  "DataInterval": "300",
  "PathDataPerInterval": {
    "UsageData": [
      {
        "Path": "/path/",
        "Time": "2017-09-30T16:00:00Z",
        "Acc": 10,
        "Traffic": 346
      }
    ]
  },
  "RequestId": "DE81639B-DAC1-4C76-AB72-F34B836837D5"
}

Error response

JSON format

{"RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8","HostId":"cdn.aliyuncs.com","Code":"InternalError","Message":"The request processing has failed due to some unknown error."}

Error codes

HTTP status code	Error code	Error message
400	InvalidPageSize.Malformed	PageSize must be of type Integer
400	InvalidPageSize.ExceedsMaximum	PageSize should be less than or equal to 1000
400	InvalidPageSize.ExceedsMinimum	PageSize should be greater than or equal to 1
400	InvalidPath.Malformed	Path must be of type String
400	InvalidStartTime.Malformed	StartTime must be of type String
400	InvalidEndTime.Malformed	EndTime must be of type String
400	InvalidDomainName.Malformed	DomainName must be of type String
400	MissingParameter	DomainName is required
400	InvalidDomainName.TooShort	DomainName should be at least 1 chars long
400	InvalidPageNumber.Malformed	PageNumber must be of type Integer
400	InvalidPageNumber.ExceedsMinimum	PageNumber should be greater than or equal to 1
400	InvalidTime.OverRange	Specified StartTime or EndTime is over range

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.