文档首页/ 安全云脑 SecMaster/ API参考/ API V3/ 订阅管理/ 获取订阅资源信息
更新时间：2025-08-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取订阅资源信息

功能介绍

获取订阅资源信息

调用方法

请参见如何调用API。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取项目ID

约束限制：

不涉及

取值范围：

不涉及w

默认取值：

不涉及

workspace_id

是

String

工作空间ID
表2 Query参数

参数

是否必选

参数类型

描述

sku

是

String

参数解释:

SKU信息

  • FLOW_DATA_BANDWIDTH 数据流量带宽

  • CSS_CAPACITY CSS 存储容量

  • PAIMON_CAPACITY Paimon 存储容量

  • OBS_CAPACITY OBS 存储容量

  • JOB_CAPACITY 作业处理容量

  • AD_HOC_COUNT 即席查询次数

约束限制

不涉及

取值范围:

  • FLOW_DATA_BANDWIDTH

  • CSS_CAPACITY

  • PAIMON_CAPACITY

  • OBS_CAPACITY

  • JOB_CAPACITY

  • AD_HOC_COUNT

默认值

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。获取用户Token

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

project_id

String

项目ID

sku

String

参数解释:

sku类型

  • FLOW_DATA_BANDWIDTH 数据带宽

  • CSS_CAPACITY 索引集群容量

  • PAIMON_CAPACITY 数据库容量

  • OBS_CAPACITY 对象存储容量

  • JOB_CAPACITY 作业容量

  • AD_HOC_COUNT 即席查询数量

约束限制

不涉及

取值范围:

  • FLOW_DATA_BANDWIDTH

  • CSS_CAPACITY

  • PAIMON_CAPACITY

  • OBS_CAPACITY

  • JOB_CAPACITY

  • AD_HOC_COUNT

默认值

不涉及

upper_limit

Double

资源上限值

unit

String

配额单位（如 GB、条、分片等）

step

Double

配额步长

used_amount

Double

已使用的资源数量

unused_amount

Double

剩余可用的资源数量

version

Long

版本号

create_time

Integer

毫秒时间戳

update_time

Integer

毫秒时间戳

index_storage_upper_limit

Long

索引存储上限

index_shards_upper_limit

Long

索引分片上限

index_shards_unused

Long

剩余可用索引分片数量

partitions_unused

Long

剩余可用分区数量

partition_upper_limit

Long

分区上限

请求示例

无

响应示例

无

状态码

状态码

描述

200

订阅资源信息

错误码

请参见错误码。

父主题： 订阅管理

相关文档