DescribeDcdnDomainMultiUsageData - Edge Security Acceleration

Calls the DescribeDcdnDomainMultiUsageData operation to query the billing data for various metrics of one or more DCDN accelerated domain names. The minimum data granularity is 5 minutes. This operation does not return data for billing items that are not request-based.

Operation description

If you do not specify the StartTime and EndTime parameters, data in the last 10 minutes is returned by default. You can also query data in a specified time range. To do so, you must specify both StartTime and EndTime.
You can query data for multiple accelerated domain names at a time. Separate the domain names with commas (,). Data for each domain name is returned separately.
You can query data within the last 90 days.
The maximum time range for a query is 1 hour.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The accelerated domain names for which you want to query data. You can specify multiple domain names. Separate them with commas (,). If you do not specify this parameter, data for all accelerated domain names under your account is returned.	example.com
StartTime	string	No	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. The minimum data granularity is 5 minutes. This parameter must be used with the EndTime parameter. By default, the system reads data from the last 24 hours. Use with EndTime.	2017-12-10T20:00:00Z
EndTime	string	No	The end of the time range to query. The end time must be later than 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. This parameter must be used with the StartTime parameter. Must be used with StartTime.	2017-12-10T21:00:00Z

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range.	2017-12-10T21:00:00Z
StartTime	string	The beginning of the time range.	2017-12-10T20:00:00Z
RequestId	string	The ID of the request.	3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F
RequestPerInterval	object
RequestDataModule	array<object>	The data of requests that are monitored every 5 minutes.
	object
Type	string	The type of request. Valid values: StaticHttps, DynamicHttps, DynamicHttp, StaticQuic, and DynamicQuic.	DynamicHttp
TimeStamp	string	The beginning of the time interval.	2017-12-10T20:00:00Z
Domain	string	The accelerated domain name.	example.com
Request	integer	The number of requests.	1128
TrafficPerInterval	object
TrafficDataModule	array<object>	The traffic data that is monitored every 5 minutes.
	object
Type	string	The type of traffic. Valid values: Simple, IPA, and WebSocket.	Simple
Domain	string	The accelerated domain name.	example.com
TimeStamp	string	The beginning of the time interval.	2017-12-10T20:00:00Z
Area	string	The region.	CN
Bps	number	The bandwidth. Unit: bit/s.	11288111.1

Examples

Success response

JSON format

{
  "EndTime": "2017-12-10T21:00:00Z",
  "StartTime": "2017-12-10T20:00:00Z",
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F",
  "RequestPerInterval": {
    "RequestDataModule": [
      {
        "Type": "DynamicHttp",
        "TimeStamp": "2017-12-10T20:00:00Z",
        "Domain": "example.com",
        "Request": 1128
      }
    ]
  },
  "TrafficPerInterval": {
    "TrafficDataModule": [
      {
        "Type": "Simple",
        "Domain": "example.com",
        "TimeStamp": "2017-12-10T20:00:00Z",
        "Area": "CN",
        "Bps": 11288111.1
      }
    ]
  }
}

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	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Configure a valid time span as described in API documentation.
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.