DescribeLiveDomainRealTimeHttpCodeData - ApsaraVideo Live

This operation queries the distribution of HTTP return codes for an accelerated domain name at a 1-minute time granularity.

Operation description

The time granularity supported by this operation is as follows:

Time granularity	Maximum time span for a single query	Queryable historical time range	Data latency
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 limits

This operation is limited to 10 queries per second (QPS) for each user. If you exceed this limit, your API calls are throttled, which may affect your business. Plan your calls accordingly.

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

live:DescribeLiveDomainRealTimeHttpCodeData

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	Yes	The streaming domain. Note Ensure that the specified domain name is a streaming domain and that you have the required permissions to operate it. Separate multiple domain names with a comma (,).	example.com,example.aliyundoc.com
StartTime	string	No	The beginning of the time range to query. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note If you leave both StartTime and EndTime empty, the data within 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 yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note If you leave both StartTime and EndTime empty, the data within the last 1 hour is returned.	2015-11-30T05:40:00Z
IspNameEn	string	No	The English name of the carrier. For more information, see DescribeCdnRegionAndIsp.	alibaba
LocationNameEn	string	No	The English name of the region. For more information, see DescribeCdnRegionAndIsp.	tianjin

Response parameters

Parameter	Type	Description	Example
	object
EndTime	string	The end of the time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is displayed in UTC.	2015-11-30T05:40:00Z
StartTime	string	The beginning of the time range. The time is in the yyyy-MM-ddTHH:mm:ssZ format and 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 data records. Unit: seconds. The default value is 60.	60
RealTimeHttpCodeData	object
UsageData	array<object>	The distribution of HTTP return codes at each time interval.
	object
TimeStamp	string	The beginning of the time slice.	2015-11-30T05:39:00Z
Value	object
RealTimeCodeProportionData	array<object>	The usage data about the distribution of each return code.
	object
Code	string	The HTTP return code.	200
Proportion	string	The proportion of responses.	66.046511627907
Count	string	The number of responses.	20

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.