Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Subscription Management/ Querying Resource Subscription Information
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Resource Subscription Information

Function

This API is used to query resource subscription information.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/subscription/resource

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Workspace ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

sku

Yes

String

Definition

SKU information.

  • FLOW_DATA_BANDWIDTH: data traffic bandwidth

  • CSS_CAPACITY: CSS storage capacity

  • PAIMON_CAPACITY: Paimon storage capacity

  • OBS_CAPACITY: OBS storage capacity

  • JOB_CAPACITY: job processing capacity

  • AD_HOC_COUNT: number of ad hoc queries

Constraints

N/A

Range

  • FLOW_DATA_BANDWIDTH

  • CSS_CAPACITY

  • PAIMON_CAPACITY

  • OBS_CAPACITY

  • JOB_CAPACITY

  • AD_HOC_COUNT

Default Value

N/A

Request Parameters

Table 3 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. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

project_id

String

Project ID.

sku

String

Definition

SKU type.

  • FLOW_DATA_BANDWIDTH: data bandwidth

  • CSS_CAPACITY: index cluster capacity

  • PAIMON_CAPACITY: database capacity

  • OBS_CAPACITY: object storage capacity

  • JOB_CAPACITY: job capacity

  • AD_HOC_COUNT: number of ad hoc queries

Constraints

N/A

Range

  • FLOW_DATA_BANDWIDTH

  • CSS_CAPACITY

  • PAIMON_CAPACITY

  • OBS_CAPACITY

  • JOB_CAPACITY

  • AD_HOC_COUNT

Default Value

N/A

upper_limit

Double

Resource upper limit.

unit

String

Quota unit, such as GB, number of records, and shards.

step

Double

Quota step.

used_amount

Double

Number of used resources.

unused_amount

Double

Number of available resources.

version

Long

Version number.

create_time

Integer

Timestamp, in ms.

update_time

Integer

Timestamp, in ms.

index_storage_upper_limit

Long

Index storage upper limit.

index_shards_upper_limit

Long

Index shard upper limit.

index_shards_unused

Long

Number of available index shards.

partitions_unused

Long

Number of available partitions.

partition_upper_limit

Long

Partition upper limit.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Resource subscription information.

Error Codes

See Error Codes.

Parent topic: Subscription Management