DescribeLiveDomainMonitoringUsageData - ApsaraVideo Live

Usage notes

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 may experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeLiveDomainMonitoringUsageData	The operation that you want to perform. Set the value to DescribeLiveDomainMonitoringUsageData.
DomainName	String	No	example.com	The domain name. If you leave this parameter empty, data of all domain names is queried by default. Separate multiple domain names with commas (,).
StartTime	String	No	2022-12-10T20:00:00Z	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 do not specify this parameter, data in the previous 24 hours is queried.
EndTime	String	No	2022-12-10T22:00:00Z	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.
Region	String	No	cn-shanghai	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 (,).
InstanceId	String	No	e62af24d-a354-3b0c-9f1f-da592c4b****	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 (,).
Interval	String	No	3600	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.
SplitBy	String	No	resolution	The key that is used to group data. Valid values: domain, region, instance, and resolution. Default value: resolution. resolution specifies that data is grouped based on the resolution. Separate multiple values with commas (,).

Response parameters

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

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainMonitoringUsageData
&DomainName=example.com
&StartTime=2022-12-10T20:00:00Z
&EndTime=2022-12-10T22:00:00Z
&Region=cn-shanghai
&InstanceId=e62af24d-a354-3b0c-9f1f-da592c4b****
&Interval=3600
&SplitBy=resolution
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveDomainMonitoringUsageDataResponse>
    <EndTime>2022-12-10T22:00:00Z</EndTime>
    <StartTime>2022-12-10T20:00:00Z</StartTime>
    <RequestId>3C6CCEC4-6B88-4D4A-93E4-D47B3D92CF8F</RequestId>
    <Region>cn-shanghai</Region>
    <InstanceId>e62af24d-a354-3b0c-9f1f-da592c4b****</InstanceId>
    <DomainName>example.com</DomainName>
    <MonitoringData>
        <Region>cn-shanghai</Region>
        <TimeStamp>2022-12-10T20:00:00Z</TimeStamp>
        <Duration>2000</Duration>
        <InstanceId>e62af24d-a354-3b0c-9f1f-da592c4b****</InstanceId>
        <DomainName>example.com</DomainName>
        <Resolution>720P</Resolution>
    </MonitoringData>
</DescribeLiveDomainMonitoringUsageDataResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Common error codes

HttpCode	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The value specified for StartTime is invalid. Check whether the value of the StartTime parameter is valid.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The value specified for EndTime is invalid. Check whether the value of the EndTime parameter is valid.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.	The end time does not match the start time. Check whether the value of the EndTime parameter matches.
400	InvalidTimeSpan	The time span exceeds the limit.	The time range exceeds the limit. Configure a valid time range to query.
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, see Service error codes.

Special error codes

Error code	Error message	HTTP status code	Description
Throttling	Request was denied due to request throttling.	503	The request was denied due to throttling.
InvalidDomain.NotFound	The domain provided does not belong to you.	404	The domain name does not exist or does not belong to your account.