All Products
Search

This Product

    ApsaraVideo VOD：DescribeVodDomainHitRateData

    Document Center

    ApsaraVideo VOD：DescribeVodDomainHitRateData

    更新時間：Dec 19, 2024

    Queries the byte hit ratios of accelerated domain names. Byte hit ratios are measured in percentage.

    Operation description

    • This operation is supported only in the China (Shanghai) region.
    • You can specify a maximum of 500 accelerated domain names.
    • If you specify neither StartTime nor EndTime, the data of the last 24 hours is queried. You can specify both StartTime and EndTime parameters to query data of a specified time range.

    Time granularity

    The time granularity varies with the time range specified by the StartTime and EndTime parameters. The following table describes the time period within which historical data is available and the data delay when you do not set Interval.

    Time granularityTime range per queryHistorical data availableData delay
    5 minutesTime range per query < 3 days93 days15 minutes
    1 hour3 days ≤ Time range per query < 31 days186 days3 to 4 hours
    1 day31 days ≤ Time span of a single query ≤ 366 days366 days4 hours in most cases, not more than 24 hours

    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:
      • 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 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
    vod:DescribeVodDomainHitRateDataget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DomainNamestringNo

    The accelerated domain name.

    • If you leave this parameter empty, the merged data of all your accelerated domain names is returned.
    • You can specify multiple domain names and separate them with commas (,). You can specify a maximum of 500 domain names in each call.
    • To obtain the accelerated domain name, perform the following steps: Log on to the ApsaraVideo VOD console. In the left-side navigation pane, choose Configuration Management > CDN Configuration > Domain Names. On the Domain Names page, view the accelerated domain names. Alternatively, you can call the DescribeVodUserDomains operation to query the accelerated domain names.
    		example.com
    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.

    		2024-01-20T13:59:58Z
    EndTimestringNo

    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.
    		2024-01-20T14:59:58Z
    IntervalstringNo

    The time granularity. Unit: seconds. Valid values: 300, 3600, and 86400. If you leave this parameter empty or specify an invalid value, the default value is used. The supported time granularity varies based on the time range specified by EndTime and StartTime. The following content describes the supported time granularity.

    • Time range per query < 3 days: 300 (default), 3600, and 86400
    • 3 days ≤ Time range per query < 31 days: 3600 (default) and 86400
    • 31 days ≤ Time range per query ≤ 90 days: 86400 (default)
    		300

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned results.

    EndTimestring

    The end of the time range.

    		2024-01-20T14:59:58Z
    StartTimestring

    The beginning of the time range.

    		2024-01-20T13:59:58Z
    RequestIdstring

    The ID of the request.

    		D94E471F-1A27-442E-552D-D4D2000C****
    DomainNamestring

    The accelerated domain name.

    		example.com
    DataIntervalstring

    The time interval at which data is returned, which is the time granularity. Unit: seconds.

    		300
    HitRateIntervalarray<object>

    The byte hit rate data at each time interval.

    DataModuleobject
    Valuestring

    The total byte hit rate.

    		100
    TimeStampstring

    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.

    		2024-01-20T13:59:58Z
    HttpsValuestring

    The HTTPS byte hit rate.

    		50

    Examples

    Sample success responses

    JSONformat

    {
  "EndTime": "2024-01-20T14:59:58Z",
  "StartTime": "2024-01-20T13:59:58Z",
  "RequestId": "D94E471F-1A27-442E-552D-D4D2000C****",
  "DomainName": "example.com",
  "DataInterval": "300",
  "HitRateInterval": {
    "DataModule": [
      {
        "Value": "100",
        "TimeStamp": "2024-01-20T13:59:58Z",
        "HttpsValue": "50"
      }
    ]
  }
}

    Error codes

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