DescribeLiveDomainPublishErrorCode - ApsaraVideo Live - Alibaba Cloud Documentation Center

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

Operation description

This operation returns monitoring data. Because this data is collected and processed differently from billing data, do not use the returned data for billing purposes.
You can query data from the last 90 days.
The data is delayed by 3 to 5 minutes.

QPS limits

You can call this operation up to 10 times per second per account. Requests that exceed this limit 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: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 name. You can specify multiple domain names. Separate them with commas (,). Note This parameter is required.	example1.aliyundoc.com,example2.aliyundoc.com
AppName	string	No	The application name. Data is filtered and aggregated by application name. If you specify this parameter, you must specify a single ingest domain for the DomainName parameter.	AppName
StartTime	string	No	The start 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 do not specify this parameter, data from the last hour is queried by default.	2016-06-29T09:00: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 If you do not specify this parameter, data from the last hour is queried by default.	2016-06-29T09:10:00Z

Response parameters

Parameter	Type	Description	Example
	object	The response schema.
DataInterval	string	The time granularity of the data. Unit: seconds. The default value is 60.	60
DomainName	string	The ingest domain name.	example1.aliyundoc.com,example2.aliyundoc.com
EndTime	string	The end of the time range. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.	2016-06-29T09:10:00Z
RealTimeCodeData	array<object>	The proportions of HTTP status codes for each time interval.
	object	The proportions of HTTP status codes for each time interval.
CodeData	array<object>	A list of the proportions of different return codes.
	object	A list of the proportions of different return codes.
Code	string	The return code. Valid values: 3: Read timeout. 4: Data write error. 6: Write timeout. 200: Success. 500: Unknown internal error. 501: Stream ingest failed. 502: Signaling timed out. 401: Invalid stream ingest parameter. 403: Stream ingest authentication failed.	200
Count	string	The number of times the return code was received.	20
Proportion	string	The proportion of this return code relative to all return codes.	66.04
TimeStamp	string	The start of the time interval.	2016-06-29T09:01:00Z
RequestId	string	The request ID.	BC858082-736F-4A25-867B-E5B67C******
StartTime	string	The start of the time range. The time is in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is in 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.