DescribeMediaDistribution

Updated at: 2025-03-21 04:03

Queries the distribution of media asset data by time. The maximum time range to query is 6 months.

Operation description

  • This operation is available only in the China (Shanghai) region.
  • If you do not set the StartTime or EndTime parameter, the request returns the data collected in the previous 7 days. If you set both the parameters, the request returns the data collected within the specified time range.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
OperationAccess levelResource typeCondition keyAssociated operation
vod:DescribeMediaDistributionlist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
StartTimestringNo

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 maximum time range to query is 6 months.

2017-01-11T12:00:00Z
EndTimestringNo

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. The maximum time range to query is 6 months.

2017-01-11T12:59:00Z
StorageClassstringNo

The hierarchical storage type. Valid values:

  • Standard
  • IA
  • Archive
  • ColdArchive
  • SourceIA
  • SourceArchive
  • SourceColdArchive
  • Changing
  • SourceChanging
Standard
IntervalstringNo

The statistical interval. Default value: day. Valid values:

  • hour: natural hour of the start and end time.
  • day: natural day of the start and end time.
  • week: natural week of the start and end time.
  • month: natural month of the start and end time.
day

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The request ID.

25818875-5F78-4AF6-D7393642CA58****
Totallong

The total number of media assets returned.

100
MediaDistributionListarray<object>

The distribution list of media assets. The data is displayed based on the statistical cycle of the natural hour, day, week, or month of the start and end time.

StatisticsInfoListobject

The distribution of media assets. This parameter is empty if no data is found.

StartTimestring

The start of the time range during which data is queried (inclusive). The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-11-13T00:00:00Z
EndTimestring

The end of the time range during which data is queried (exclusive). The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

2017-11-14T00:00:00Z
Countlong

The number of media assets that are queried during the specified time range.

12

Examples

Sample success responses

JSONformat

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "Total": 100,
  "MediaDistributionList": [
    {
      "StartTime": "2017-11-13T00:00:00Z",
      "EndTime": "2017-11-14T00:00:00Z",
      "Count": 12
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2024-12-18API Description UpdateView Change Details
  • On this page (1)
  • Operation description
  • Debugging
  • Authorization information
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
Feedback