All Products
Search
Document Center

ApsaraVideo VOD:DescribeVodStorageData

Last Updated:Nov 09, 2022

Queries the usage of storage-related resources. The resources include the storage volume, storage duration, and outbound traffic.

Operation Description

Note
  • This operation is available only in the China (Shanghai) region.
  • If the time range to query is less than or equal to seven days, the system returns the statistics collected on an hourly basis. If the time range to query is greater than seven days, the system returns the statistics collected on a daily basis. The maximum time range that you can specify to query is 31 days.
  • Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
    • Condition keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operateaccess levelResource typeconditional keywordAssociation operation
    vod:DescribeVodStorageDataRead
    • VOD
      acs:vod:*:{#accountId}:*
      without
    without

    Request parameters

    ParameterTypeRequiredDescriptionExample
    StartTimestringYes

    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.

    2019-02-01T14:00:00Z
    EndTimestringYes

    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.

    2019-02-01T15:00:00Z
    RegionstringNo

    The region where media assets are stored. If you do not set this parameter, the data in all regions is returned. You can specify multiple regions. Separate them with commas (,). Valid values:

    • cn-shanghai: China (Shanghai)
    • cn-beijing: China (Beijing)
    • eu-central-1: Germany (Frankfurt)
    • ap-southeast-1: Singapore
    cn-shanghai
    StorageTypestringNo

    The storage type. Set the value to OSS.

    OSS
    StoragestringNo

    The name of the Object Storage Service (OSS) bucket. If you do not set this parameter, the data of all buckets is returned. You can specify multiple buckets. Separate them with commas (,).

    bucket

    Response parameters

    ParameterTypeDescriptionExample
    object
    DataIntervalstring

    The time granularity at which the data was queried. Valid values:

    • hour
    • day
    day
    RequestIdstring

    The ID of the request.

    C370DAF1-C838-4288-****-9A87633D248E
    StorageDataarray

    The detailed usage of storage-related resources.

    object
    TimeStampstring

    The timestamp of the returned data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

    2019-02-01T15:00:00Z
    StorageUtilizationstring

    The storage volume. Unit: byte.

    111111
    NetworkOutstring

    The outbound traffic. Unit: byte. The outbound traffic is generated when videos are directly downloaded or played from OSS buckets without Alibaba Cloud CDN acceleration.

    111111

    Example

    Normal return example

    JSONFormat

    {
      "DataInterval": "day",
      "RequestId": "C370DAF1-C838-4288-****-9A87633D248E",
      "StorageData": [
        {
          "TimeStamp": "2019-02-01T15:00:00Z",
          "StorageUtilization": "111111",
          "NetworkOut": "111111"
        }
      ]
    }

    Error codes

    For a list of error codes, visit the API error center.

    Common errors

    The following table describes the common errors that this operation can return.

    Error codeError messageHTTP status codeDescription
    ThrottlingRequest was denied due to request throttling.503The error message returned because the request was denied due to throttling.
    OperationDeniedYour account does not open VOD service yet.403The error message returned because ApsaraVideo VOD has not been activated for your Alibaba Cloud account.
    OperationDeniedYour VOD service is suspended.403The error message returned because ApsaraVideo VOD has been suspended for your Alibaba Cloud account.
    InvalidParameterInvalid Parameter.400The error message returned because one or more parameters are invalid.
    InvalidParameterAliUidInvalid Parameter AliUid.400The error message returned because the value of the AliUid parameter is invalid.
    InvalidParameterStartTimeInvalid Parameter StartTime.400The error message returned because the value of the StartTime parameter is invalid.
    InvalidParameterEndTimeInvalid Parameter EndTime.400The error message returned because the value of the EndTime parameter is invalid.
    InvalidTimeRangeStartTime and EndTime range should less than 1 month.400The error message returned because the time range that is specified by the StartTime and EndTime parameters exceeds 31 days.
    InvalidParameterRegionInvalid Parameter Region.400The error message returned because the value of the Region parameter is invalid.