DescribeDomainUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

You can query the resource usage data of up to 100 domain names at a time. Separate multiple domain names with commas (,). If you do not specify the DomainName parameter, the system returns the resource usage data of all domain names within your Alibaba Cloud account.
The resource usage data includes network traffic measured in bytes, bandwidth measured in bit/s, and the number of requests.
If you do not specify the Interval parameter, you can query resource usage data from the last 12 months for a period of up to 31 days per call. For queries spanning 1 to 3 days, the time interval between returned entries is 1 hour. For queries spanning more than 3 days, the time interval between returned entries is 1 day.
The following table describes the maximum time range per query, the time period within which historical data is available, and the data delay when you specify the Interval parameter:

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

QPS limits

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you consider this limit when calling this operation.

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 support 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
DomainName	string	No	The domain name. You can query one or more domain names. If you specify multiple domain names, separate them with commas (,). If you do not specify this parameter, the data of all domain names within your Alibaba Cloud account is returned.	example.com
StartTime	string	Yes	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2015-12-10T20:00:00Z
EndTime	string	Yes	The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The end time must be later than the start time. The time span cannot exceed 31 days.	2015-12-10T21:00:00Z
Type	string	No	The type of content that you want to query. When Field is set to bps or traf, valid values for this parameter are: rts: RTS bandwidth or traffic. quic: QUIC bandwidth or traffic. all: all types. When Field is set to req_traf or req_bps, valid values for this parameter are: push: ingest bandwidth or traffic. push_proxy: forwarding bandwidth or traffic.	all
Field	string	Yes	The category of the resource usage data to query. Valid values: bps: playback bandwidth. traf: traffic. req_traf: When Type is set to push, this value indicates ingest traffic. When Type is set to push_proxy, this value indicates forwarding traffic. req_bps: When Type is set to push, this value indicates ingest bandwidth. When Type is set to push_proxy, this value indicates forwarding bandwidth.	traf
Area	string	No	The ID of the billable region. Valid values: CN: Chinese mainland. OverSeas: regions 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 you do not specify this parameter, the default value CN is used. Alibaba Cloud supports the following countries and regions outside the Chinese mainland: - Asia Pacific 1: Hong Kong (China), Macao (China), Taiwan (China), Japan, and Southeast Asia excluding Vietnam and Indonesia. - Asia Pacific 2: Indonesia, Republic of Korea, and Vietnam. - Asia Pacific 3: Australia and New Zealand. North America: US and Canada. - South America: Brazil. - Europe: Ukraine, UK, France, Netherlands, Spain, Italy, Sweden, and Germany. - Middle East and Africa: South Africa, Oman, UAE, and Kuwait.	CN
DataProtocol	string	No	The protocol of the data that you want to query. Valid values: http: HTTP protocol. https: HTTPS protocol. quic: QUIC protocol. all (default): all protocols.	all
Interval	string	No	The time granularity of the data entries. Unit: seconds. Valid values: 300 (5 minutes), 3600 (1 hour), and 86400 (1 day).	300

Note

When you query data at time T, stable data is available at time T+N, where N is 2 hours.
Example: If you query data at 13:00 on December 21, stable data for 13:00 and earlier is available at 15:00 on December 21.

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end time. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-10T21:00Z
Type	string	The type of content.	all
StartTime	string	The start time. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-10T20:00Z
RequestId	string	The ID of the request.	B955107D-E658-4E77-B913-E0AC3D31693E
Area	string	The billable region where the data was collected.	CN
DomainName	string	The domain name.	example.com
DataInterval	string	The time interval between the entries returned. Unit: seconds.	300
UsageDataPerInterval	object
DataModule	array	The resource usage data that was collected for each time interval.
	object
Value	string	The amount of resources consumed. When Field is set to traf or req_traf, the unit is bytes. When Field is set to bps or req_bps, the unit is bit/s. When Field is set to acc, the unit is count.	423304182
TimeStamp	string	The timestamp of the returned data. The time follows the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-12-10T20:00:00Z

## Special error codes | Error code | Error message | HTTP status code | Description | | ---------- | ------------- | ---------------- | ----------- | | Throttling | Request was denied due to request throttling. | 503 | The error message returned because the request was denied due to throttling. | | IllegalOperation | Illegal domain, operation is not permitted. | 403 | The error message returned because the domain name is invalid. | | OperationDenied | Your account does not open Live service yet. | 403 | The error message returned because ApsaraVideo Live is not activated. | | OperationDenied | Your Live service is suspended. | 403 | The error message returned because ApsaraVideo Live is suspended. | | InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | The error message returned because the domain name does not exist or does not belong to your account. | | InvalidDomain.Offline | The domain provided is offline. | 404 | The error message returned because the domain name is disabled. | | ServiceBusy | The specified Domain is configuring, please retry later. | 403 | The error message returned because the domain name is being configured. Try again later. | | InvalidDomain.Configure_failed | Failed to configure the provided domain. | 500 | The error message returned because the domain name failed to be configured. | | InvalidParameter | Invalid Parameter. | 400 | The error message returned because one or more parameters are invalid. | | InvalidParameterProduct | Invalid Parameter Product. | 400 | The error message returned because the value of the Product parameter is invalid. | | InvalidParameterArea | Invalid Parameter Area. | 400 | The error message returned because the value of the Area parameter is invalid. | | InvalidParameterField | Invalid Parameter Field. | 400 | The error message returned because the value of the Field parameter is invalid. | | InvalidParameterStartTime | Invalid Parameter StartTime. | 400 | The error message returned because the value of the StartTime parameter is invalid. | | InvalidParameterEndTime | Invalid Parameter EndTime. | 400 | The error message returned because the value of the EndTime parameter is invalid. | | InvalidTimeRange | StartTime and EndTime range should less than 1 month. | 400 | The error message returned because the time range that is specified by the StartTime and EndTime parameters exceeds 31 days. | | InvalidParameterInterval | Invalid Parameter Interval. | 400 | The error message returned because the value of the Interval parameter is invalid. |

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.