DescribeLiveDrmUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Usage notes

You can query data in the previous 90 days.
The maximum time range to 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	DescribeLiveDrmUsageData	The operation that you want to perform. Set the value to DescribeLiveDrmUsageData.
DomainName	String	No	example.com	The domain name. Separate multiple domain names with commas (,). If you leave this parameter empty, the aggregated data of all domain names is returned.
StartTime	String	Yes	2021-05-01T16: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 time granularity is 5 minutes.
EndTime	String	Yes	2021-05-02T16: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.
Interval	String	No	3600	The time granularity of the query. Unit: seconds. Valid values: 300 3600 86400 Default value: 3600.
SplitBy	String	No	domain,region,drm_type	The key that is used to group data. The following keys are supported: domain, region, and drm_type. If you want to specify multiple keys, separate them with commas (,). Default value: domain,region,drm_type. If you leave this parameter empty or set it to null, the returned data is not grouped.

Response parameters

Parameter	Type	Example	Description
DrmUsageData	Array of DataModule		The usage of the DRM encryption service at each time interval.
DataModule
Count	Long	1	The number of times DRM-encrypted live streams are requested.
Domain	String	example.com	The domain name. If the value of SplitBy includes domain, the returned data is grouped by domain name.
DrmType	String	Widevine	The DRM type. If the value of SplitBy includes drm_type, the returned data is grouped by DRM type.
Region	String	cn-beijing	The ID of the region. If the value of SplitBy includes region, the returned data is grouped by region.
TimeStamp	String	2021-05-01T16:00:00Z	The timestamp of the returned data.
RequestId	String	91FC2D9D-B042-4634-8A5C-7B8E7482C22D	The request ID.

Examples

Sample request

http(s)://live.aliyuncs.com/?Action=DescribeLiveDrmUsageData
&DomainName=example.com
&StartTime=2021-05-01T16:00:00Z
&EndTime=2021-05-02T16:00:00Z
&Interval=3600
&SplitBy=domain,region,drm_type
&<Common request parameters>

Sample success responses

XML format

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

<DescribeLiveDrmUsageDataResponse>
    <DrmUsageData>
        <Count>1</Count>
        <Domain>example.com</Domain>
        <DrmType>Widevine</DrmType>
        <Region>cn-beijing</Region>
        <TimeStamp>2021-05-01T16:00:00Z</TimeStamp>
    </DrmUsageData>
    <RequestId>91FC2D9D-B042-4634-8A5C-7B8E7482C22D</RequestId>
</DescribeLiveDrmUsageDataResponse>

JSON format

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

{
  "DrmUsageData" : [ {
    "Count" : 1,
    "Domain" : "example.com",
    "DrmType" : "Widevine",
    "Region" : "cn-beijing",
    "TimeStamp" : "2021-05-01T16:00:00Z"
  } ],
  "RequestId" : "91FC2D9D-B042-4634-8A5C-7B8E7482C22D"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The format of the start time is invalid.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The format of the end time is invalid.
400	InvalidEndTime.Mismatch	Specified end time does not match the specified start time.	The end time does not match the start time.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.	The value of StartTime is invalid.

For a list of error codes, see Service error codes.