DescribeLiveDomainMonitoringUsageData - ApsaraVideo Live

Call the DescribeLiveDomainMonitoringUsageData operation to query monitoring usage data for a domain name.

Operation description

You can query multiple domain names at a time. Separate the domain names with a comma (,).
You can query data from the last 90 days.
The time granularity for a query can be an hour or a day.
The maximum time range for a query is 31 days.

Limits

The queries per second (QPS) limit for a single user on this operation is 20. If you exceed the limit, your API calls are throttled, which may affect your business. Call this operation within the specified limit.

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

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-shanghai
DomainName	string	No	The streaming domain name that you want to query. You can query one or more domain names. To query multiple domain names, separate them with a comma (,). If you leave this parameter empty, the merged data for all your streaming domains is returned by default.	example.com
StartTime	string	No	The beginning of the time range to query. The time must be in UTC and in the `YYYY-MM-DDThh:mm:ssZ` format. The minimum data granularity is 1 hour. If you do not set this parameter, data from the last 24 hours is queried by default. By default, the system reads data from the last 24 hours.	2022-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 UTC and in the `YYYY-MM-DDThh:mm:ssZ` format.	2022-12-10T22:00:00Z
Region	string	No	The live center region. If you leave this parameter empty, the merged data for all regions is returned by default. You can query multiple regions. To do so, separate the region IDs with a comma (,).	cn-shanghai
InstanceId	string	No	The monitoring session ID. If you leave this parameter empty, the merged data for all monitoring sessions is returned by default. You can query multiple sessions. To do so, separate the session IDs with a comma (,).	e62af24d-a354-3b0c-9f1f-da592c4b****
Interval	string	No	The time granularity of the query. Valid values are 3600 (by hour) and 86400 (by day).	3600
SplitBy	string	No	The key to group the data by. The default value is resolution, which groups data by definition. Valid values are domain, region, instance, and resolution. You can specify multiple keys. To do so, separate them with a comma (,).	resolution

Response elements

Element	Type	Description	Example
	object	The response parameters.
DomainName	string	The domain name.	example.com
EndTime	string	The end of the time range that was queried.	2022-12-10T22:00:00Z
InstanceId	string	The monitoring session ID.	e62af24d-a354-3b0c-9f1f-da592c4b****
MonitoringData	object
MonitoringDataItem	array<object>	The details of monitoring usage.
	object	The details.
DomainName	string	The domain name. This parameter is returned only when you set SplitBy to domain.	example.com
Duration	integer	The duration. Unit: minutes.	2000
InstanceId	string	The monitoring session ID. This parameter is returned only when you set SplitBy to instance.	e62af24d-a354-3b0c-9f1f-da592c4b****
Region	string	The live center region. This parameter is returned only when you set SplitBy to region.	cn-shanghai
Resolution	string	The resolution. This parameter is returned only when you set SplitBy to resolution.	720P
TimeStamp	string	The start time of the time slice.	2022-12-10T20:00:00Z
Region	string	The live center region.	cn-shanghai
RequestId	string	The request ID.	3C6CCEC4-6B88-4D4A-93E4-D47B3******
StartTime	string	The beginning of the time range that was queried.	2022-12-10T20:00:00Z

Examples

Success response

JSON format

{
  "DomainName": "example.com",
  "EndTime": "2022-12-10T22:00:00Z",
  "InstanceId": "e62af24d-a354-3b0c-9f1f-da592c4b****",
  "MonitoringData": {
    "MonitoringDataItem": [
      {
        "DomainName": "example.com",
        "Duration": 2000,
        "InstanceId": "e62af24d-a354-3b0c-9f1f-da592c4b****",
        "Region": "cn-shanghai",
        "Resolution": "720P",
        "TimeStamp": "2022-12-10T20:00:00Z"
      }
    ]
  },
  "Region": "cn-shanghai",
  "RequestId": "3C6CCEC4-6B88-4D4A-93E4-D47B3******",
  "StartTime": "2022-12-10T20:00:00Z"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
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.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value specified for the StartTime parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.