DescribeLiveDrmUsageData - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

Usage notes

You can query data from the last 90 days.
The maximum time span for a query is 31 days.

QPS limits

The queries per second (QPS) limit for a single user is 20. If the limit is exceeded, throttling is triggered, which may affect your business. Call this operation as needed. For more information, see QPS limits.

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

get

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	No	The live streaming domain name. You can query one or more domain names. To query more than one domain name, separate them with commas (,). If you leave this parameter empty, the merged data for all live streaming domain names is returned.	example.com
StartTime	string	Yes	The start 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 5 minutes.	2021-05-01T16:00:00Z
EndTime	string	Yes	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.	2021-05-02T16:00:00Z
Interval	string	No	The time granularity of the data to query. Unit: seconds. Valid values: 300 3600 86400 If you do not specify this parameter or specify an invalid value, the default value of 3600 is used.	3600
SplitBy	string	No	The key to group data by. The default value is domain,region,drm_type. You can specify one or more of the following values: domain, region, and drm_type. Separate multiple values with commas (,). If you set this parameter to null or leave it empty, the data is not grouped by these keys.	domain,region,drm_type

Response elements

Element	Type	Description	Example
	object
DrmUsageData	object
DataModule	array<object>	The DRM usage data for each time interval.
	object	The DRM usage data for each time interval.
Count	integer	The number of calls.	1
Domain	string	The domain name for which the usage is queried. This parameter is returned when you set SplitBy to domain.	example.com
DrmType	string	The DRM type. This parameter is returned when you set SplitBy to drm_type.	Widevine
Region	string	The live center. This parameter is returned when you set SplitBy to region.	cn-beijing
TimeStamp	string	The start of the time slice.	2021-05-01T16:00:00Z
RequestId	string	The request ID.	91FC2D9D-B042-4634-8A5C-7B8E7482C22D

Examples

Success response

JSON format

{
  "DrmUsageData": {
    "DataModule": [
      {
        "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.
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	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.