All Products
Search
Document Center

ApsaraVideo Live:DescribeLiveDomainPublishErrorCode

Last Updated:Mar 06, 2024

Queries HTTP status codes for stream ingest by domain name.

Usage notes

  • This operation is called to monitor data. The data is collected and processed in a manner different from that for billing. Therefore, the data that is returned by this operation cannot be used as a reference to calculate the resource usage for billing.
  • You can query data in the last 90 days.
  • The data latency for this operation is 3 to 5 minutes.

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes DescribeLiveDomainPublishErrorCode

The operation that you want to perform. Set the value to DescribeLiveDomainPublishErrorCode.

DomainName String No example.com,example.aliyundoc.com

The ingest domain. You can specify multiple ingest domains. Separate multiple values with commas (,).

AppName String No AppName

The name of the application. Data is filtered and aggregated by AppName. If you specify this parameter, you need to specify a specific ingest domain for the DomainName parameter.

StartTime String No 2016-06-29T09:00:00Z

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 do not specify the StartTime or EndTime parameter, the data of the last hour is returned.
EndTime String No 2016-06-29T09:10:00Z

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 the StartTime or EndTime parameter, the data of the last hour is returned.

Response parameters

Parameter

Type

Example

Description

RequestId String BC858082-736F-4A25-867B-E5B67C85ACF7

The request ID.

DataInterval String 60

The time granularity of the query. Unit: seconds. Default value: 60.

DomainName String example.com,example.aliyundoc.com

The ingest domain.

StartTime String 2016-06-29T09:00:00Z

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.

EndTime String 2016-06-29T09:10:00Z

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.

RealTimeCodeData Array of rtcd

The proportions of status codes at each time interval.

TimeStamp String 2016-06-29T09:01:00Z

The timestamp of the data returned.

CodeData Array of cd

The proportions of status codes.

Code String 200

The status code returned. 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 times out.
  • 401: A stream ingest parameter is invalid.
  • 403: The stream ingest authentication fails.
Count String 20

The total number of the status codes returned.

Proportion String 66.04

The proportion of the status code.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=DescribeLiveDomainPublishErrorCode
&DomainName=example.com,example.aliyundoc.com
&AppName=AppName
&StartTime=2016-06-29T09:00:00Z
&EndTime=2016-06-29T09:10:00Z
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveDomainPublishErrorCodeResponse>
    <RequestId>BC858082-736F-4A25-867B-E5B67C85ACF7</RequestId>
    <DataInterval>60</DataInterval>
    <DomainName>example.com,example.aliyundoc.com</DomainName>
    <StartTime>2016-06-29T09:00:00Z</StartTime>
    <EndTime>2016-06-29T09:10:00Z</EndTime>
    <RealTimeCodeData>
        <TimeStamp>2016-06-29T09:01:00Z</TimeStamp>
        <CodeData>
            <Code>200</Code>
            <Count>20</Count>
            <Proportion>66.04</Proportion>
        </CodeData>
    </RealTimeCodeData>
</DescribeLiveDomainPublishErrorCodeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.