DescribeLiveDomainPublishErrorCode API Reference - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Queries the stream ingest status codes for an ingest domain within a specified time range.

Operation description

This operation is a monitoring data API. The data collection and processing method differs from billing and cannot be used to calculate usage for reconciliation purposes.
You can query data from the last 90 days.
Data is delayed by 3 to 5 minutes.

QPS limit

The QPS limit for a single user is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.

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:DescribeLiveDomainPublishErrorCode

get

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
DomainName	string	No	The ingest domain. You can specify multiple ingest domains. Separate multiple domain names with commas (,). Note This parameter is required.	example1.aliyundoc.com,example2.aliyundoc.com
AppName	string	No	Filters and aggregates data by AppName. If you specify AppName, you must set DomainName to a specific ingest domain.	AppName
StartTime	string	No	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). Note If you do not set this parameter, data from the last hour is queried by default.	2016-06-29T09:00:00Z
EndTime	string	No	The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format (UTC). Note If you do not set this parameter, data from the last hour is queried by default.	2016-06-29T09:10:00Z

Response elements

Element	Type	Description	Example
	object	Schema of Response
DataInterval	string	The time granularity of the queried data. Unit: seconds. Default value: 60.	60
DomainName	string	The ingest domain.	example1.aliyundoc.com,example2.aliyundoc.com
EndTime	string	The end time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2016-06-29T09:10:00Z
RealTimeCodeData	array<object>	The status code distribution data for each time interval.
	array<object>	The status code distribution data for each time interval.
CodeData	array<object>	The list of status code distribution data.
	object	The list of status code distribution data.
Code	string	The HTTP status code. Valid values: 3: The data read times out. 4: A data write error occurs. 6: The data write times out. 200: The request is successful. 500: An unknown internal error occurs. 501: The stream ingest fails. 502: The signaling operation timed out. 401: A stream ingest parameter is invalid. 403: The stream ingest authentication fails.	200
Count	string	The total number of the HTTP status codes returned.	20
Proportion	string	The proportion of the HTTP status code.	66.04
TimeStamp	string	The start time of the time interval. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2016-06-29T09:01:00Z
RequestId	string	The request ID.	BC858082-736F-4A25-867B-E5B67C******
StartTime	string	The start time. The time is in the yyyy-MM-ddTHH:mm:ssZ format (UTC).	2016-06-29T09:00:00Z

Examples

Success response

JSON format

{
  "DataInterval": "60",
  "DomainName": "example1.aliyundoc.com,example2.aliyundoc.com",
  "EndTime": "2016-06-29T09:10:00Z",
  "RealTimeCodeData": [
    {
      "CodeData": [
        {
          "Code": "200",
          "Count": "20",
          "Proportion": "66.04"
        }
      ],
      "TimeStamp": "2016-06-29T09:01:00Z"
    }
  ],
  "RequestId": "BC858082-736F-4A25-867B-E5B67C******",
  "StartTime": "2016-06-29T09:00:00Z"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.