DescribeLiveDomainPublishErrorCode - ApsaraVideo Live - Alibaba Cloud Documentation Center

Queries the HTTP status codes that are returned within a specified period of time under an ingest domain.

Operation description

This operation is used to monitor data. The returned data cannot be used as a reference to calculate resource usage for billing.
You can query data within the previous 90 days.
The data is delayed for 3 to 5 minutes.

QPS limits

You can call this API 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:DescribeLiveDomainPublishErrorCode	get	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DomainName	string	No	The ingest domain. If you want to specify multiple ingest domains, separate them with commas (,). Note This parameter is required.	example.com,example.aliyundoc.com
AppName	string	No	The application name. The data is aggregated based on the application. If you specify this parameter, the DomainName parameter is required.	AppName
StartTime	string	No	The start time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note If you do not configure StartTime, the data within the previous hour is queried.	2016-06-29T09:00:00Z
EndTime	string	No	The end time. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. Note If you do not configure StartTime, the data within the previous hour is queried.	2016-06-29T09:10:00Z

You can specify both the StartTime and EndTime parameters to query the data in the specified period of time. If you do not specify the StartTime and EndTime parameters, the data of the last hour is queried by default.

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
DataInterval	string	The time granularity of the query. Unit: seconds. Default value: 60.	60
DomainName	string	The ingest domain.	example.com,example.aliyundoc.com
EndTime	string	The end of the time range during which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2016-06-29T09:10:00Z
RealTimeCodeData	array<object>	The proportions of error codes at each time interval.
rtcd	object	The proportion of the error code at each time interval.
CodeData	array<object>	The proportions of error codes.
cd	object	The proportion of the error code.
Code	string	The response code. Valid values: 3: The data read timed out. 4: A data write error occurred. 6: The data write timed out. 200: The request is successful. 500: An unknown internal error occurred. 501: The stream ingest failed. 502: The signaling operation timed out. 401: A stream ingest parameter is invalid. 403: The stream ingest authentication failed.	200
Count	string	The number of times the HTTP status code was returned.	20
Proportion	string	The proportion of the HTTP status code.	66.04
TimeStamp	string	The timestamp of the data returned.	2016-06-29T09:01:00Z
RequestId	string	The request ID.	BC858082-736F-4A25-867B-E5B67C85ACF7
StartTime	string	The beginning of the time range during which data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2016-06-29T09:00:00Z

Error code	HTTP status code	Description
NGX_RTMP_EF_READ_TIMEDOUT 3	3	A timeout occurred while reading the data.
NGX_RTMP_EF_WRITE_ERROR 4	4	An error occurred while writing the data.
NGX_RTMP_EF_WRITE_TIMEDOUT 6	6	A timeout occurred while writing the data.
NGX_RTMP_EF_NETCALL_INTERNAL_ERROR 500	500	An unknown internal system error occurred.
NGX_RTMP_EF_NETCALL_EXCEPTION 501	501	A stream ingest exception occurred.
NGX_RTMP_EF_NETCALL_TOO_LONG 502	502	The signaling took too long.
NGX_RTMP_EF_NETCALL_UNAUTHORIZED 401	401	Abnormal stream ingest parameters exist.
NGX_RTMP_EF_NETCALL_FORBIDDEN 403	403	Failed to authenticate the ingested stream.

Examples

Sample success responses

JSONformat

{
  "DataInterval": "60",
  "DomainName": "example.com,example.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-E5B67C85ACF7",
  "StartTime": "2016-06-29T09:00:00Z"
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history