Updated on 2024-10-21 GMT+08:00

Querying Stream Monitoring Data

Function

This API is used to query the monitoring data of a specified stream.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/streams/{stream_name}/metrics

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

stream_name

Yes

String

Stream name

Maximum: 60

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

label

No

String

Stream monitoring metric (Either label or label_list must be specified. If both label_list and label exist, label_list is used.)

  • total_put_bytes_per_stream: total input traffic (byte)

  • total_get_bytes_per_stream: total output traffic (byte)

  • total_put_records_per_stream: total input records

  • total_get_records_per_stream: total output records

  • total_put_req_latency: average processing time (milliseconds) of upload requests

  • total_get_req_latency: average processing time (milliseconds) of download requests

  • total_put_req_suc_per_stream: number of successful upload requests

  • total_get_req_suc_per_stream: number of successful download requests

  • traffic_controll_put: number of rejected upload requests due to flow control

  • traffic_controll_get: number of rejected download requests due to flow control

Enumeration values:

  • total_put_bytes_per_stream

  • total_get_bytes_per_stream

  • total_put_records_per_stream

  • total_get_records_per_stream

  • total_put_req_latency

  • total_get_req_latency

  • total_put_req_suc_per_stream

  • total_get_req_suc_per_stream

  • traffic_control_put

  • traffic_control_get

label_list

No

String

List of labels separated by commas (,) to query multiple labels in batches. (Either label or label_list must be specified. If both label_list and label exist, label_list is used.)

start_time

Yes

Long

Monitoring start time, which is a 10-digit timestamp

end_time

Yes

Long

Monitoring end time, which is a 10-digit timestamp

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

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 the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

metrics

Metrics object

Data object

metrics_list

Array of Metrics objects

List of monitored data objects

Table 5 Metrics

Parameter

Type

Description

dataPoints

Array of DataPoint objects

Monitoring data

label

String

Monitoring metric

Table 6 DataPoint

Parameter

Type

Description

timestamp

Long

Timestamp

value

Long

Monitoring value corresponding to the timestamp

Example Requests

Querying Stream Monitoring Data

GET https://{Endpoint}/v2/{project_id}/streams/{stream_name}/metrics

Example Responses

None

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
48
49
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.dis.v2.region.DisRegion;
import com.huaweicloud.sdk.dis.v2.*;
import com.huaweicloud.sdk.dis.v2.model.*;


public class ShowStreamMetricsSolution {

    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");

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

        DisClient client = DisClient.newBuilder()
                .withCredential(auth)
                .withRegion(DisRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowStreamMetricsRequest request = new ShowStreamMetricsRequest();
        request.withLabel(ShowStreamMetricsRequest.LabelEnum.fromValue("<label>"));
        request.withLabelList("<label_list>");
        request.withStartTime(<start_time>L);
        request.withEndTime(<end_time>L);
        try {
            ShowStreamMetricsResponse response = client.showStreamMetrics(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
32
33
34
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdis.v2.region.dis_region import DisRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdis.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"]

    credentials = BasicCredentials(ak, sk)

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

    try:
        request = ShowStreamMetricsRequest()
        request.label = "<label>"
        request.label_list = "<label_list>"
        request.start_time = <start_time>
        request.end_time = <end_time>
        response = client.show_stream_metrics(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
38
39
40
41
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dis "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dis/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dis/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dis/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")

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

    client := dis.NewDisClient(
        dis.DisClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowStreamMetricsRequest{}
	labelRequest:= model.GetShowStreamMetricsRequestLabelEnum().<LABEL>
	request.Label = &labelRequest
	labelListRequest:= "<label_list>"
	request.LabelList = &labelListRequest
	request.StartTime = int64(<start_time>)
	request.EndTime = int64(<end_time>)
	response, err := client.ShowStreamMetrics(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

Normal response

Error Codes

See Error Codes.