DescribeVodDomainRealTimeHttpCodeData - ApsaraVideo VOD

Queries the total number of HTTP status codes and proportion of each HTTP status code for one or more accelerated domains. The minimum time granularity is 1 minute. The minimum data latency is 5 minutes. You can query data in the last 186 days.

Operation description

This operation is supported only in the China (Shanghai) region.
You can specify a maximum of 100 accelerated domain names.
If you specify neither StartTime nor EndTime, the data of the last 1 hour 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.

Time granularity	Time range per query	Historical data available (days)	Data latency
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	3 to 4 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
vod:DescribeVodDomainRealTimeHttpCodeData	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The accelerated domain name. You can specify multiple domain names and separate them with commas (,). You can specify at most 100 domain names in each call. If you specify multiple domain names, merged data is returned. 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
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 ISP. If you do not set this parameter, all ISPs are queried.	unicom
LocationNameEn	string	No	The name of the region. If you do not set this parameter, data in all regions is queried.	shanghai

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range.	2019-11-30T05:40:00Z
StartTime	string	The beginning of the time range.	2019-11-30T05:39:00Z
RequestId	string	The ID of the request.	BC858082-736F-4A25-867B-E5B67C85ACF7
DomainName	string	The accelerated domain name.	example.com
DataInterval	string	The time interval at which data is returned. Unit: seconds. The returned value varies based on the time range per query. Valid values: 60 (1 minute), 300 (5 minutes), and 3600 (1 hour). For more information, see the Time granularity section in the API documentation.	60
RealTimeHttpCodeData	array<object>	The proportion of each HTTP status code in each time interval.
UsageData	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	array<object>	The proportion of each HTTP status code is displayed in a data list.
RealTimeCodeProportionData	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

Sample success responses

JSONformat

{
  "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

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