Help Center/ Live/ Cloud Live API Reference/ Stream Analytics/ Querying relay task analytics
Updated on 2026-01-07 GMT+08:00

Querying relay task analytics

Function

Interface for querying carousel task monitoring data, including frame rate and bit rate monitoring data of carousel tasks.

The maximum query span is 3 hours, and the maximum query period is 7 days.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v2/{project_id}/stats/carousel-task/detail

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

carousel_task_id

Yes

String

Carousel task ID.

start_time

No

String

Start time. The date format follows the ISO 8601 notation and uses UTC time.

The format is: YYYY-MM-DDThh:mm:ssZ. The maximum query span is 3 hours, and the maximum query period is 7 days.

If the parameter is left empty, data for the last 1 hour will be queried by default.

end_time

No

String

End time. The date format follows the ISO 8601 notation and uses UTC time.

The format is: YYYY-MM-DDThh:mm:ssZ. The maximum query span is 3 hours, and the maximum query period is 7 days.

If the parameter is left empty, the current time is used by default. The end time must be later than the start time.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Authorization

No

String

Authentication information. This parameter is mandatory when AK/SK-based authentication is used.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.

X-Project-Id

No

String

Project ID, which is the same as that used in the URI. This parameter is mandatory when AK/SK-based authentication is used.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Unique identifier of the request.

Table 5 Response body parameters

Parameter

Type

Description

start_time

String

Sampling start time. The date format follows the ISO 8601 notation and uses UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.

end_time

String

Sampling end time. The date format follows the ISO 8601 notation and uses UTC time. The format is: YYYY-MM-DDThh:mm:ssZ.

video_framerate_list

Array of longs

List of video frame rate information, in fps.

video_bitrate_list

Array of longs

List of video bitrate information, in Kbps.

audio_framerate_list

Array of longs

List of audio frame rate information, in fps.

audio_bitrate_list

Array of longs

List of audio bitrate information, in Kbps.

Status code: 400

Table 6 Response header parameters

Parameter

Type

Description

X-Request-Id

String

Unique identifier of the request.

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

Query carousel task monitoring.

GET /v2/{project_id}/stats/carousel-task/detail?carousel_task_id=2d4f6a8c-1e3b-479d-8a6c-7e5d4b3f2a09

Example Responses

Status code: 200

Processing completed successfully.

{
  "start_time" : "2022-02-04T07:00:00Z",
  "end_time" : "2022-02-04T07:00:02Z",
  "video_framerate_list" : [ 100, 200 ],
  "video_bitrate_list" : [ 100, 200 ],
  "audio_framerate_list" : [ 100, 200 ],
  "audio_bitrate_list" : [ 100, 200 ]
}

Status code: 400

If the processing fails, a message is returned.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: carousel_task_id"
}

SDK Sample Code

The SDK sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.live.v2.region.LiveRegion;
import com.huaweicloud.sdk.live.v2.*;
import com.huaweicloud.sdk.live.v2.model.*;


public class ListCarouselTaskDetailSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        LiveClient client = LiveClient.newBuilder()
                .withCredential(auth)
                .withRegion(LiveRegion.valueOf("<YOUR REGION>"))
                .build();
        ListCarouselTaskDetailRequest request = new ListCarouselTaskDetailRequest();
        try {
            ListCarouselTaskDetailResponse response = client.listCarouselTaskDetail(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdklive.v2.region.live_region import LiveRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdklive.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = LiveClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(LiveRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListCarouselTaskDetailRequest()
        response = client.list_carousel_task_detail(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := live.NewLiveClient(
        live.LiveClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListCarouselTaskDetailRequest{}
	response, err := client.ListCarouselTaskDetail(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

This code is returned if the request succeeds.

400

This code is returned if the request failed to be fulfilled.

Error Codes

See Error Codes.