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

Queries monitoring data by directory, including traffic and the number of visits.

Operation description

This operation is available only to whitelisted users (whose peak bandwidth of the domain name is 10 Gbps or higher). To apply, submit a ticket. If eligible, the configuration will be completed in the background.
Rate limit per user: 6,000 calls per minute.
Currently, directory-level bandwidth statistics can be enabled only for specific domain names under an account, not for all domain names.
The average size of all files under the domain name must be greater than 1 MB.
The number of directories for each domain name cannot exceed 100. If the number of directories exceeds 100, data accuracy decreases and query results may be inaccurate.
If you do not specify StartTime and EndTime, the system queries data from the last 24 hours by default. You can also specify a start time and an end time to query data within a specific time range. Both parameters must be specified at the same time.
You can query data from the last 30 days at most.

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 page number. Pages start from 1.	1
PageSize	integer	No	The number of entries per page. Valid values: any integer from 1 to 1000.	20
Path	string	No	The path. It must start with a forward slash (/). If you do not specify this parameter, all paths are queried. If the path is a directory, it must end with a forward slash (/). Note Fuzzy match is not supported for path information. You must specify the directory depth for the query, and it can only be set to a fixed value. For example, if you set it to a first-level directory /path/, the system collects bandwidth statistics specifically for the first-level directory.	/path/
StartTime	string	No	The start time. 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 time. 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 the 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 Only a single domain name is supported for each query.	example.com

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time. The time follows the ISO 8601 standard and is in UTC.	2017-09-30T17:00:00Z
StartTime	string	The start time. The time follows the ISO 8601 standard and is in UTC.	2017-09-30T16:00:00Z
PageSize	integer	The number of entries per page.	20
PageNumber	integer	The current page number. Pages start from 1.	1
TotalCount	integer	The total number of path bandwidth data entries.	2
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval. Unit: seconds.	300
PathDataPerInterval	object
UsageData	array<object>	The list of path bandwidth data.
	object
Path	string	The path.	/path/
Time	string	The timestamp. The time follows the ISO 8601 standard and is in UTC.	2017-09-30T16:00:00Z
Acc	integer	The number of visits.	10
Traffic	integer	The traffic. Unit: bytes.	346
RequestId	string	The request ID.	DE81639B-DAC1-4C76-AB72-F34B836837D5

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