DescribeDomainUsageData API Reference - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Operation description

This operation supports batch domain name queries. Separate multiple domain names with commas (,). You can query up to 100 domain names at a time. If the DomainName parameter is empty, data for all domain names under the account is returned.
Usage data includes three types: traffic, bandwidth, and requests, measured in bytes, bit/s, and count respectively.
If you do not specify the Interval parameter, you can query data for up to the last year, and the maximum time span per query is 31 days. For a query period of 1 to 3 days, data is returned at hourly granularity. For a query period longer than 3 days, data is returned at daily granularity.
When you specify the Interval parameter, the supported maximum time span per query, the historical data range, and the data delay are as follows:

Time granularity	Maximum time span per query	Historical data range	Data delay
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	4 hours
1 day	90 days	366 days	4:00 AM the next day

QPS limit

The QPS limit for a single user on this operation is 10 calls per second. If the limit is exceeded, the API call is throttled, which may affect your business. Call this operation appropriately.

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

live:DescribeDomainUsageData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	No	The streaming domain. You can specify a single domain name or multiple domain names. Separate multiple domain names with commas (,). If this parameter is empty, the merged data of all streaming domains is returned by default.	example.com
StartTime	string	Yes	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2015-12-10T20:00:00Z
EndTime	string	Yes	The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). The end time must be later than the start time, and the difference between the end time and the start time cannot exceed 31 days.	2015-12-10T21:00:00Z
Type	string	No	The type of usage data to retrieve. When Field is set to bps or traf, valid values: rts: RTS bandwidth or traffic. quic: QUIC bandwidth or traffic. When Field is set to req_traf or req_bps, valid values: push: stream ingest bandwidth or traffic. push_proxy: relay bandwidth or traffic. Valid values: rts : RTS bandwidth or traffic. all : all. normal : normal. static : static. dynamic : dynamic. push_proxy : relay bandwidth or traffic. quic : QUIC bandwidth or traffic. push : stream ingest bandwidth or traffic.	all
Field	string	Yes	The data type of the usage data to query. Valid values: bps: playback bandwidth. traf: traffic. req_traf: when Type is set to push, this indicates stream ingest traffic. When Type is set to push_proxy, this indicates relay traffic. req_bps: when Type is set to push, this indicates stream ingest bandwidth. When Type is set to push_proxy, this indicates relay bandwidth.	traf
Area	string	No	The region code. Valid values: CN: the Chinese mainland. OverSeas: outside 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 regions. Note If this parameter is not specified, the default value is the Chinese mainland. Regions outside the Chinese mainland: - Asia-Pacific 1: Hong Kong (China), Macao (China), Taiwan (China), Japan, and Southeast Asian countries except Vietnam and Indonesia. - Asia-Pacific 2: Indonesia, South Korea, and Vietnam. - Asia-Pacific 3: Australia and New Zealand. North America: the United States and Canada. - South America: Brazil. - Europe: Ukraine, the United Kingdom, France, the Netherlands, Spain, Italy, Sweden, and Germany. - Middle East and Africa: South Africa, Oman, the United Arab Emirates, and Kuwait.	CN
DataProtocol	string	No	The protocol of the data to retrieve. Valid values: http: HTTP. https: HTTPS. quic: QUIC. all (default): all of the preceding protocols.	all
Interval	string	No	Forces retrieval of data at the specified time granularity, in seconds. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day).	300

Note

When querying data at time T, stable data is available at time T+N, where N is 2 hours.
Example: If you query data for 1:00 PM on December 21, you can obtain stable data for 1:00 PM and earlier at 3:00 PM on December 21.

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2015-12-10T21:00Z
Type	string	The usage type.	all
StartTime	string	The start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC).	2015-12-10T20:00Z
RequestId	string	The request ID.	B955107D-E658-4E77-B913-E0AC3D31693E
Area	string	The usage region.	CN
DomainName	string	The streaming domain.	example.com
DataInterval	string	The time interval of each record. Unit: seconds.	300
UsageDataPerInterval	object
DataModule	array<object>	The traffic data of each record.
	object
Value	string	The usage value. If Field is set to traf or req_traf, the unit is bytes. If Field is set to bps or req_bps, the unit is bps. If Field is set to acc, the unit is counts.	423304182
TimeStamp	string	The start time of the time slice. The time is in UTC and the format is yyyy-MM-ddTHH:mm:ssZ.	2015-12-10T20:00:00Z

Examples

Success response

JSON format

{
  "EndTime": "2015-12-10T21:00Z",
  "Type": "all",
  "StartTime": "2015-12-10T20:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "Area": "CN",
  "DomainName": "example.com",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "423304182",
        "TimeStamp": "2015-12-10T20:00:00Z"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvaildParameter	Invalid Parameter	Invalid request parameter.
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.
400	InvalidTime.Malformed	Specified Time is malformed.	Invalid time. Check whether the time that you specified is correct.
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	Specified end time does not math the specified start time.	The end time does not match the start time. Make sure that the start and end times match.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Please refer to the API documentation to specify a reasonable time span.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.