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

Querying App Consumption Status

Function

This API is used to query the consumption status of an app.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/apps/{app_name}/streams/{stream_name}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

app_name

Yes

String

Name of the app to be queried

stream_name

Yes

String

Name of the stream to be queried

Maximum: 60

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Max. number of partitions to list in a single API call. The minimum value is 1 and the maximum value is 1,000. The default value is 100.

Minimum: 1

Maximum: 1000

Default: 100

start_partition_id

No

String

Name of the partition to start the partition list with. The returned partition list does not contain this partition.

checkpoint_type

Yes

String

Type of the checkpoint.

  • LAST_READ: Only sequence numbers are recorded in databases.

Enumeration values:

  • LAST_READ

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

has_more

Boolean

Whether there are more matching consumer applications.

  • true: yes

  • false: no

stream_name

String

Name of the stream to be queried

Maximum: 64

app_name

String

Name of the consumer application to be queried

partition_consuming_states

Array of PartitionConsumingStates objects

Consumption status of the current partition

Table 5 PartitionConsumingStates

Parameter

Type

Description

partition_id

String

Partition identifier of the stream.Two partition ID formats are available:- shardId-0000000000- 0For example, if a stream has three partitions, the partition IDs are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002.

sequence_number

String

Sequence number to be submitted, which is used to record the consumption checkpoint of the stream. Ensure that the sequence number is within the valid range.

latest_offset

Long

Latest index position

earliest_offset

Long

Earliest index position

checkpoint_type

String

Type of the checkpoint.

  • LAST_READ: Only sequence numbers are recorded in databases.

Enumeration values:

  • LAST_READ

status

String

Current status of the partition

  • CREATING

  • ACTIVE

  • DELETED

  • EXPIRED

Enumeration values:

  • CREATING

  • ACTIVE

  • DELETED

  • EXPIRED

Example Requests

Querying App Consumption Status

GET https://{Endpoint}/v2/{project_id}/apps/{app_name}/streams/{stream_name}

Example Responses

Status code: 200

Normal response

{
  "has_more" : false,
  "stream_name" : "disMonitorTest",
  "app_name" : "4aSiZ",
  "partition_consuming_states" : [ {
    "partition_id" : 0,
    "sequence_number" : -1,
    "latest_offset" : 1658297359,
    "earliest_offset" : 1653120573,
    "checkpoint_type" : "LAST_READ",
    "status" : "ACTIVE"
  } ]
}

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
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 ShowConsumerStateSolution {

    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();
        ShowConsumerStateRequest request = new ShowConsumerStateRequest();
        request.withLimit(<limit>);
        request.withStartPartitionId("<start_partition_id>");
        request.withCheckpointType(ShowConsumerStateRequest.CheckpointTypeEnum.fromValue("<checkpoint_type>"));
        try {
            ShowConsumerStateResponse response = client.showConsumerState(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
# 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 = ShowConsumerStateRequest()
        request.limit = <limit>
        request.start_partition_id = "<start_partition_id>"
        request.checkpoint_type = "<checkpoint_type>"
        response = client.show_consumer_state(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
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.ShowConsumerStateRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	startPartitionIdRequest:= "<start_partition_id>"
	request.StartPartitionId = &startPartitionIdRequest
	request.CheckpointType = model.GetShowConsumerStateRequestCheckpointTypeEnum().<CHECKPOINT_TYPE>
	response, err := client.ShowConsumerState(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.