文档

GetCapacity - 获取当前企业威胁分析存储的使用量及购买量

更新时间:

获取当前威胁分析存储的使用量以及预付费的购买量,单位为GB。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:GetCapacityWrite
  • acs:yundun-sas::{#accountId}:*

请求参数

名称类型必填描述示例值
RoleTypeinteger

视图类型。

  • 0:当前阿里云账号视图。
  • 1:企业下所有账号的视图。
1
RoleForlong

管理员切换成其他成员视角的用户 ID。

113091674488****
RegionIdstring

威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:

  • cn-hangzhou:资产属于中国内地与中国香港,选择该项。
  • ap-southeast-1:资产属于海外地域,选择该项。
cn-hangzhou

返回参数

名称类型描述示例值
object

CloudSiemResponse

Dataobject

容量明细。

UsedCapacitydouble

威胁分析当前计费容量(GB)。

10
PreservedCapacitylong

威胁分析用户购买容量(GB)。

9000
ExistLogStoreboolean

威胁分析用户侧 LogStore 是否存在。取值:

  • true:当前日志正常,日志分析可用
  • false:当前正在清理日志,日志分析不可用
true
RequestIdstring

请求消息 ID。

27D27DCB-D76B-5064-8B3B-0900DEF7****

示例

正常返回示例

JSON格式

{
  "Data": {
    "UsedCapacity": 10,
    "PreservedCapacity": 9000,
    "ExistLogStore": true
  },
  "RequestId": "27D27DCB-D76B-5064-8B3B-0900DEF7****"
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorThe request processing has failed due to some unknown error.服务发生某些未知错误,请稍后再试
500Siem.Storage.ExceptionThe request timed out, try again.获取存储信息超时。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:RoleType
    新增入参:RoleFor
2023-12-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 500 变更
    删除错误码:501
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)