DescribeLiveDomainRealTimeHttpCodeData - ApsaraVideo Live

Queries the proportions of HTTP status codes returned for one or more domain names. Data is collected every minute.

Operation description

The following table describes the time granularities supported by this operation.

Time granularity	Maximum time range per query	Historical data available	Data delay
1 minute	1 hour	7 days	5 minutes
5 minutes	3 days	93 days	15 minutes
1 hour	31 days	186 days	Usually 4 hours
1 day	Unlimited	366 days	After 04:00 on the next day

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.

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
live:DescribeLiveDomainRealTimeHttpCodeData	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	Yes	The streaming domain. Separate multiple domain names with commas (,).	example.com,example.aliyundoc.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. Note If you specify neither the StartTime parameter nor the EndTime parameter, the data of the last 1 hour is returned.	2015-11-30T05:39:00Z
EndTime	string	No	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. Note If you specify neither the StartTime parameter nor the EndTime parameter, the data of the last 1 hour is returned.	2015-11-30T05:40:00Z
IspNameEn	string	No	The name of the Internet service provider (ISP). You can call the DescribeCdnRegionAndIsp operation to query a list of available ISPs.	alibaba
LocationNameEn	string	No	The name of the region. You can call the DescribeCdnRegionAndIsp operation to query a list of available regions.	tianjin

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range during which the data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-11-30T05:40:00Z
StartTime	string	The beginning of the time range during which the data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2015-11-30T05:33:00Z
RequestId	string	The request ID.	BC858082-736F-4A25-867B-E5B67C85ACF7
DomainName	string	The streaming domain.	example.com,example.aliyundoc.com
DataInterval	string	The time interval between the entries returned. Unit: seconds Default value: 60.	60
RealTimeHttpCodeData	array<object>	The proportions of HTTP status codes at each time interval.
UsageData	object
TimeStamp	string	The timestamp of the data returned.	2015-11-30T05:39:00Z
Value	array<object>	The proportions of HTTP status codes.
RealTimeCodeProportionData	object
Code	string	The HTTP status code.	200
Proportion	string	The proportion of the HTTP status code.	66.046511627907
Count	string	The number of times the HTTP status code was returned.	20

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	MissingTimeParameter	The StartTime and EndTime must be both 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.
400	InvalidStartTime.ValueNotSupported	The specified StartTime is invalid.

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

Change history

Change time	Summary of changes	Operation
2024-09-29	API Description Update. The Error code has changed	View Change Details