tencent cloud

云点播

DescribeLicenseUsageData

Download
聚焦模式
字号
最后更新时间: 2026-05-19 15:02:51

1. API Description

Domain name for API request: vod.intl.tencentcloudapi.com.

This interface returns information about the number of license requests per day within the query time range.

  1. You can query the license request statistics in the last 365 days.
  2. The query time span does not exceed 90 days.
  3. If the query time span exceeds 1 day, data with a granularity of days will be returned. Otherwise, data with a granularity of 5 minutes will be returned.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeLicenseUsageData.
Version Yes String Common Params. The value used for this API: 2018-07-17.
Region No String Common Params. This parameter is not required.
StartTime Yes String Start date. Use the ISO date format.
EndTime Yes String End date, which must be greater than or equal to the start date. Use the ISO date format.
LicenseType No String License type, defaults to CommercialDRMLicense. Currently supports license types including:
  • CommercialDRMLicense: enterprise-grade DRM License
  • SubAppId No Integer VOD application ID. Customers who activate VOD services after December 25, 2023 must fill this field with the application ID when accessing resources in on-demand applications (whether default or newly created).

    3. Output Parameters

    Parameter Name Type Description
    LicenseUsageDataSet Array of LicenseUsageDataItem License query count stats show detailed data of the queried license.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying DRM license requests

    Input Example

    https://vod.intl.tencentcloudapi.com/?Action=DescribeLicenseUsageData
    &LicenseType=DRM
    &StartTime=2020-09-07T00:00:00+08:00
    &EndTime=2020-09-09T23:59:59+08:00
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "LicenseUsageDataSet": [
                {
                    "Time": "2020-09-07T00:00:00+08:00",
                    "Count": 2
                },
                {
                    "Time": "2020-09-08T00:00:00+08:00",
                    "Count": 2
                },
                {
                    "Time": "2020-09-09T00:00:00+08:00",
                    "Count": 2
                }
            ],
            "RequestId": "requestId"
        }
    }
    

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    InternalError Internal error.
    InvalidParameterValue Parameter value error.

    帮助和支持

    本页内容是否解决了您的问题?

    填写满意度调查问卷,共创更好文档体验。

    文档反馈