Skip to content

获取当前租户的存储用量与配额

GET
/v1/tenants/me/storage

默认返回逻辑用量(各文档版本大小求和、用户感知值);传 dimension=physical 时 usageBytes 切到物理用量(去重后实际占用字节求和),其他任何取值(含拼写错误、空值)均按 logical 处理,不会报错。返回值带 5 分钟级缓存延迟,sampledAt 字段为采样时刻 epoch 毫秒;调用方不应将返回值视为实时强一致数据。

授权

apiKey
类型
API Key (header: Authorization)

参数

请求头参数

X-Atk-User-Token

强通道:系统自签的不透明用户会话 token,用于 Client 代表用户调用。 与 X-Atk-Act-As-Source / X-Atk-Act-As-Source-Id 互斥,同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型
string
X-Atk-Act-As-Source

弱通道:身份 source 主张(要求 Client 已开启 actAsAllowed)。 必须与 X-Atk-Act-As-Source-Id 成对携带,缺一服务端返回 400 INCOMPLETE_ACT_AS_HEADERS;与 X-Atk-User-Token 互斥,同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型
string
X-Atk-Act-As-Source-Id

弱通道:身份 sourceId 主张(要求 Client 已开启 actAsAllowed)。 必须与 X-Atk-Act-As-Source 成对携带,缺一服务端返回 400 INCOMPLETE_ACT_AS_HEADERS;与 X-Atk-User-Token 互斥,同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型
string

查询参数

dimension
类型
string

响应

OK

*/*
JSON
{
  
"code": 0,
  
"data": {
  
  
"tenantId": "string",
  
  
"dimension": "string",
  
  
"usageBytes": 0,
  
  
"logicalUsageBytes": 0,
  
  
"physicalUsageBytes": 0,
  
  
"documentCount": 0,
  
  
"versionCount": 0,
  
  
"quotaBytes": 0,
  
  
"softLimitRatio": 0,
  
  
"enforced": true,
  
  
"sampledAt": 0
  
},
  
"ts": 0,
  
"rid": "string",
  
"msg": "string",
  
"success": true
}

试验场

服务器
授权
请求头
变量

示例

技术支持 VitePress OpenAPI