All Products
Search

This Product

    ApsaraVideo VOD:DescribeVodDomainSrcBpsData

    Document Center

    ApsaraVideo VOD:DescribeVodDomainSrcBpsData

    Last Updated:Jul 21, 2026

    Queries the back-to-origin bandwidth data of accelerated domain names.

    Operation description

    • Currently, this operation supports only the following service address: China (Shanghai).

    • Batch queries are supported. You can query data for up to 500 domain names at a time.

    • If you do not specify StartTime and EndTime, this operation returns data from the past 24 hours by default. If you specify StartTime and EndTime, this operation returns data for the specified time range.

    Time granularity of returned data

    Based on the time span specified by StartTime and EndTime, and when Interval is not set, the default time granularity of returned data, the queryable historical data range, and data latency are as follows:

    Time granularityTime span per queryQueryable historical data rangeData latency
    5 minutesTime span per query < 3 days93 days15 minutes
    1 hour3 days ≤ Time span per query < 31 days186 daysGenerally 3 to 4 hours
    1 day31 days ≤ Time span per query ≤ 366 days366 daysGenerally 4 hours, up to 24 hours

    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

    vod:DescribeVodDomainSrcBpsData

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DomainName

    string

    No

    The accelerated domain name to query.

    • If you do not specify this parameter, the pooled data of all accelerated domain names is returned by default.

    • Batch queries are supported. Separate multiple domain names with commas (,). You can specify up to 500 domain names at a time.

    • Log on to the ApsaraVideo VOD console, and choose Configuration Management > CDN Configuration > Domain Names in the left-side navigation pane to view the accelerated domain names that you have added to ApsaraVideo VOD. You can also call the DescribeVodUserDomains operation to query the list of accelerated domain names.

    example.com
    StartTime

    string

    No

    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.

    2022-04-25T16:00:00Z
    EndTime

    string

    No

    The end 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.

    Note

    The end time must be later than the start time.

    2022-04-26T15:59:59Z
    Interval

    string

    No

    The time granularity of the data entries. Unit: seconds. Valid values: 300, 3600, and 86400. If you do not specify this parameter or specify an unsupported value, the default value is used. Based on the time span specified by StartTime and EndTime, the supported time granularity values are as follows:

    • Less than 3 days (exclusive): 300 (default), 3600, and 86400.

    • 3 to 31 days (exclusive): 3600 (default) and 86400.

    • 31 days or more: 86400 (default).

    300

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    EndTime

    string

    The end of the time range for the returned data.

    2022-08-23T02:02:57Z
    StartTime

    string

    The beginning of the time range for the returned data.

    2022-07-12T16:00:00Z
    RequestId

    string

    The request ID.

    25818875-5F78-4A13-BEF6-****
    DomainName

    string

    The accelerated domain name.

    sample.com
    DataInterval

    string

    The time interval between consecutive data entries, which is the time granularity of the data. Unit: seconds.

    300
    SrcBpsDataPerInterval

    object

    DataModule

    array<object>

    The list of back-to-origin bandwidth data for each time interval.

    object

    The origin bandwidth data at each time interval.

    Value

    string

    The total origin bandwidth data. Unit: bit/s.

    0
    TimeStamp

    string

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

    2022-08-23T02:02:57Z

    HttpsValue

    string

    The bandwidth consumed for fetching resources from the origin over HTTPS.

    0

    Examples

    Success response

    JSON format

    {
  "EndTime": "2022-08-23T02:02:57Z",
  "StartTime": "2022-07-12T16:00:00Z",
  "RequestId": "25818875-5F78-4A13-BEF6-****",
  "DomainName": "sample.com",
  "DataInterval": "300",
  "SrcBpsDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2022-08-23T02:02:57Z\n",
        "HttpsValue": "0"
      }
    ]
  }
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 MissingParameter StartTime and EndTime can not be single.
    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 InvalidEndTime.Mismatch Specified end time does not math the specified start time.
    400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported.
    400 Abs.DomainName.Malformed The size of DomainName is too big.
    400 InvalidInterval.Malformed Specified Interval is malformed.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.