DescribeVodEditingUsageData - ApsaraVideo VOD - Alibaba Cloud Documentation Center

Operation description

Request rate limit per user: 10 requests per second

Supported time granularity:

Based on the maximum time span for a single query, the corresponding automatic rotation time granularity and queryable historical data time range are as follows:

Time granularity	Maximum time span for a single query	Queryable historical data time range
1 hour	7 days	31 days
1 day	31 days	366 days

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 support 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

vod:DescribeVodEditingUsageData

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
StartTime	string	No	The start time for data retrieval. The date format follows the ISO8601 notation and uses UTC time. Format: YYYY-MM-DDThh:mmZ. If this parameter is empty, data from the last 24 hours is read by default.	2024-11-06T16:00:00Z
EndTime	string	No	The end time for data retrieval. The date format follows the ISO8601 notation and uses UTC time. Format: YYYY-MM-DDThh:mmZ.	2024-11-07T16:00:00Z
Region	string	No	Region. Returns all regions by default. Supports batch queries, with multiple regions separated by commas (,).	cn-beijing
Specification	string	No	Output specification.	H264.SD
AppId	string	No	Application ID. For more information, see Multi-application.	app-****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	Request ID.	6CB55B62-6E5F-54D1-80BF-DFA3DE9F0***
StartTime	string	The start time for data retrieval. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).	2024-11-06T16:00:00Z
EndTime	string	The end time for data retrieval. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).	2024-11-07T16:00:00Z
EditingData	array<object>	Usage data.
	object
Specification	string	Output specification.	H264.SD
Region	string	Region.	cn-beijing
TimeStamp	string	Start time of the time slice. Uses UTC time, format: yyyy-MM-ddTHH:mm:ssZ (UTC time).	2024-11-06T16:00:00Z
Duration	integer	Audio/video duration. Unit: seconds.	123

Examples

Success response

JSON format

{
  "RequestId": "6CB55B62-6E5F-54D1-80BF-DFA3DE9F0***",
  "StartTime": "2024-11-06T16:00:00Z",
  "EndTime": "2024-11-07T16:00:00Z",
  "EditingData": [
    {
      "Specification": "H264.SD",
      "Region": "cn-beijing",
      "TimeStamp": "2024-11-06T16:00:00Z",
      "Duration": 123
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	The start time is in an invalid format.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	The end time is in an invalid format.
400	InvalidParameterType	The specified Type is invalid.	The Type parameter is invalid. Modify the value of the Type parameter based on the documentation.
400	InvalidTimeSpan	The time span exceeds the limit.	The time span exceeds the limit. Configure a valid time span based on the documentation.
400	InvalidParameter	Invalid input parameter.	Input parameter error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.