文档首页/ 安全云脑 SecMaster/ API参考/ 安全云脑 API V2/ 订阅管理/ 获取订阅资源信息 - ShowSubscriptionResources
更新时间:2026-01-29 GMT+08:00
分享

获取订阅资源信息 - ShowSubscriptionResources

功能介绍

获取订阅资源信息

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

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

订阅资源信息

{
  "create_time" : 0,
  "index_shards_unused" : 58,
  "index_shards_upper_limit" : 100,
  "index_storage_upper_limit" : 120,
  "partition_upper_limit" : 100,
  "partitions_unused" : 79,
  "project_id" : "c796dfc5f1644915ae072b7642a2cd93",
  "sku" : "FLOW_DATA_BANDWIDTH",
  "step" : 0.1,
  "unit" : "MB",
  "unused_amount" : 44.5,
  "update_time" : 0,
  "upper_limit" : 50,
  "used_amount" : 5.5,
  "version" : 1200
}

SDK代码示例

SDK代码示例如下。

 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.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;


public class ShowSubscriptionResourcesSolution {

    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");
        String projectId = "{project_id}";

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

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowSubscriptionResourcesRequest request = new ShowSubscriptionResourcesRequest();
        request.withWorkspaceId("{workspace_id}");
        try {
            ShowSubscriptionResourcesResponse response = client.showSubscriptionResources(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());
        }
    }
}
 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = ShowSubscriptionResourcesRequest()
        request.workspace_id = "{workspace_id}"
        response = client.show_subscription_resources(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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")
    projectId := "{project_id}"

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

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowSubscriptionResourcesRequest{}
	request.WorkspaceId = "{workspace_id}"
	response, err := client.ShowSubscriptionResources(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

订阅资源信息

错误码

请参见错误码

相关文档