DescribeDcdnTopDomainsByFlow-阿里云帮助中心

Queries the top domain names ranked by traffic for a user. You can retrieve data for the last 90 days.

Operation description

If you do not specify StartTime and EndTime, the data for the current month is retrieved by default. If you specify StartTime and EndTime, the data is queried based on the specified start and end time.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The start time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2016-03-01T04:00:00Z
EndTime	string	No	The end time of the data to retrieve. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The end time must be later than the start time.	2016-03-14T07:34:00Z
Limit	integer	No	The maximum number of domain names to return. Default value: 20. Valid values: 1 to 100.	20

Response elements

Element	Type	Description	Example
	object
DomainOnlineCount	integer	The total number of running domain names under the account.	68
EndTime	string	The end time. The time is displayed in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2016-03-14T07:34:00Z
StartTime	string	The start time. The time is displayed in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2016-03-14T06:34:00Z
RequestId	string	The ID of the request.	4E09C5D7-E1CF-4CAA-A45E-8727F4C8FD70
DomainCount	integer	The total number of domain names under the account.	68
TopDomains	object
TopDomain	array<object>	The list of top domain names.
	object
MaxBps	integer	The peak bandwidth.	22139626
Rank	integer	The ranking.	1
TotalAccess	integer	The total number of requests.	3
TrafficPercent	string	The traffic proportion.	21.686305274906182
DomainName	string	The domain name.	example.com
TotalTraffic	string	The total traffic.	123
MaxBpsTime	string	The time when the peak bandwidth was reached. The time is displayed in the ISO 8601 standard and in UTC.	2018-11-01T08:10:00Z

Examples

Success response

JSON format

{
  "DomainOnlineCount": 68,
  "EndTime": "2016-03-14T07:34:00Z",
  "StartTime": "2016-03-14T06:34:00Z",
  "RequestId": "4E09C5D7-E1CF-4CAA-A45E-8727F4C8FD70",
  "DomainCount": 68,
  "TopDomains": {
    "TopDomain": [
      {
        "MaxBps": 22139626,
        "Rank": 1,
        "TotalAccess": 3,
        "TrafficPercent": "21.686305274906182",
        "DomainName": "example.com",
        "TotalTraffic": "123",
        "MaxBpsTime": "2018-11-01T08:10:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	You must set both the start time and the end time.
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	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	The end time is earlier than the start time.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.	The specified start time is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.