DescribeLiveDomainMonitoringUsageData - ApsaraVideo Live

Queries the live monitoring usage data for one or more domain names.

Operation description

You can specify one or more domain names. Separate multiple domain names with commas (,).
You can query data in the last 90 days.
The data is queried by hour or day.
The maximum time range for a query is 31 days.

QPS limit

You can call this operation up to 20 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DescribeLiveDomainMonitoringUsageData	get	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The main streaming domain to query. You can query one or more domain names. If you specify multiple domain names, separate them with commas (,). If you leave this parameter empty, the data of all domain names within your Alibaba Cloud 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 1 hour. If you leave this parameter empty, data in the previous 24 hours is queried.	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 the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time must be in UTC.	2022-12-10T22:00:00Z
Region	string	No	The region of the live center. If you leave this parameter empty, data of all regions is queried by default. Separate multiple regions with commas (,).	cn-shanghai
InstanceId	string	No	The ID of the monitoring session. If you leave this parameter empty, data of all monitoring sessions is queried by default. Separate multiple session IDs with commas (,).	e62af24d-a354-3b0c-9f1f-da592c4b****
Interval	string	No	The time granularity. Valid values: 3600 and 86400. 3600 specifies that data is queried by hour and 86400 specifies that data is queried by day.	3600
SplitBy	string	No	The key that is used to group data. Valid values: domain, region, instance, and resolution. Default value: resolution. resolution specifies that data is grouped by resolution. Separate multiple values with commas (,).	resolution

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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-D47B3D92CF8F",
  "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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-29	API Description Update. The Error code has changed	View Change Details