Query real-time HTTP status codes for accelerated domains by calling DescribeVodDomainRealTimeHttpCodeData - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Queries the total number and proportion of HTTP status codes for an accelerated domain name. This operation supports a minimum data time granularity of 1 minute, with a data delay of at least 5 minutes, and allows you to query data from the last 186 days.

Operation description

Currently, this operation is available only in the China (Shanghai) region.
Batch queries are supported. You can query data for up to 100 domain names at a time.
If you do not specify StartTime and EndTime, this operation returns data from the last hour by default. If you specify StartTime and EndTime, this operation returns data for the specified time range.

Time granularity of returned data

The time granularity of returned data varies based on the time range specified by StartTime and EndTime. The following table describes the queryable historical data range and data delay for each time granularity:

Time granularity	Time range per query	Queryable historical data range	Data delay
1 minute	Time range per query ≤ 1 hour	7 days	5 minutes
5 minutes	1 hour < Time range per query < 3 days	93 days	15 minutes
1 hour	3 days ≤ Time range per query < 31 days	186 days	Typically 3 to 4 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:DescribeVodDomainRealTimeHttpCodeData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name to query. Separate multiple domain names with commas (,). You can specify up to 100 domain names at a time. When you query multiple domain names, the returned data is the aggregated data of all specified domain names. You can 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.	2019-11-30T05:39: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.	2019-11-30T05:40:00Z
IspNameEn	string	No	The name of the Internet service provider (ISP) in English. If you do not specify this parameter, data for all ISPs is queried.	unicom
LocationNameEn	string	No	The name of the region in English. If you do not specify this parameter, data for all regions is queried.	shanghai

Response elements

Element	Type	Description	Example
	object
EndTime	string	The end of the time range for the returned data.	2019-11-30T05:40:00Z
StartTime	string	The beginning of the time range for the returned data.	2019-11-30T05:39:00Z
RequestId	string	The request ID.	BC858082-736F-4A25-867B-E5B67C85ACF7
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval between data entries. Unit: seconds. Based on the time range per query, this parameter returns a fixed value of 60 (1 minute), 300 (5 minutes), or 3600 (1 hour). For more information, see Time granularity of returned data in the operation description.	60
RealTimeHttpCodeData	object
UsageData	array<object>	The HTTP status code proportion data for each time interval.
	array<object>
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.	2019-11-30T05:39:00Z
Value	object
RealTimeCodeProportionData	array<object>	The proportion of each HTTP status code is displayed in a data list.
	object
Code	string	The HTTP status code.	500
Proportion	string	The proportion of the HTTP status code in percentage.	28.4496124031008
Count	string	The number of the HTTP status codes.	100

Examples

Success response

JSON format

{
  "EndTime": "2019-11-30T05:40:00Z",
  "StartTime": "2019-11-30T05:39:00Z",
  "RequestId": "BC858082-736F-4A25-867B-E5B67C85ACF7",
  "DomainName": "example.com",
  "DataInterval": "60",
  "RealTimeHttpCodeData": {
    "UsageData": [
      {
        "TimeStamp": "2019-11-30T05:39:00Z",
        "Value": {
          "RealTimeCodeProportionData": [
            {
              "Code": "500",
              "Proportion": "28.4496124031008",
              "Count": "100"
            }
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingTimeParameter	The StartTime and EndTime must be both specified.	Both start time and end must be specified
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	The specified EndTime is invalid.
400	InvalidEndTime.Mismatch	The specified EndTime is earlier than the StartTime.	End time is earlier than start time
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.