Help Center/ Data Ingestion Service/ API Reference/ API Description/ Stream Management/ Querying the Scaling Logs of the Current Stream Partition
Updated on 2025-11-25 GMT+08:00

Querying the Scaling Logs of the Current Stream Partition

Function

This API is used to query the scaling logs of the current stream partition.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. For how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 64 characters. Only letters and digits are allowed.

Default Value

N/A

stream_name

Yes

String

Definition

Name of the stream whose scaling logs are to be queried.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. For details, see Token-based Authentication.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

create_timestamp

No

Long

Definition

Scaling execution timestamp, which is a 13-digit timestamp

Constraints

N/A

Range

N/A

Default Value

N/A

src_partition_count

No

Integer

Definition

Number of partitions before scaling

Constraints

N/A

Range

N/A

Default Value

N/A

target_partition_count

No

Integer

Definition

Number of partitions after scaling

Constraints

N/A

Range

N/A

Default Value

N/A

result_code

No

Integer

Definition

Response code of the scaling operation result

Constraints

N/A

Range

1: successful

0: failed

Default Value

N/A

auto_scale

No

Boolean

Definition

Whether the scaling operation is automatic

Constraints

N/A

Range

  • true: auto scaling

  • false: manual scaling

Default Value

N/A

Response Parameters

Status code: 200

Normal response

None

Example Requests

Query the scaling logs of the current stream partition.

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

{
  "auto_scale" : false,
  "create_timestamp" : 1756386086180,
  "result_code" : 1,
  "src_partition_count" : 2,
  "target_partition_count" : 1
}

Example Responses

None

Status Codes

Status Code

Description

200

Normal response

Error Codes

See Error Codes.