查询用户资源

最近更新时间: 2026-09-17 00:00:49

1. 接口描述

接口请求域名： cbs.api3.fincloud.tencent.cn。

本接口（DescribeUserTotalResources）用于查询用户在所有地域的云盘数量、快照数量及配额。

默认接口请求频率限制：20次/秒。

接口更新时间：2025-08-28 18:25:05。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeUserDiskResources
Version	是	否	String	公共参数，本接口取值：2017-03-12
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Regions	否	否	Array of String	指定要查询的地域，支持同时传入多个地域。不传该参数，则默认查询所有地域。示例值： region1

3. 输出参数

参数名称	类型	描述
ResourcesDetailSet	Array of ResourcesDetail	描述第个地域的资源详情。示例值：查看
DiskOverview	DiskOverview	描述指定地域云硬盘总体使用情况。示例值：查看
SnapOverview	SnapOverview	描述指定地域快照总体使用情况。示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameterValue	无效参数值。参数值格式错误或者参数值不被支持等。
MissingParameter	参数缺失。请求没有带必选参数。

5. 示例

示例1 查询用户资源

查询用户资源

输入示例

{}

输出示例

{
  "Response": {
    "SnapOverview": {
      "SnapshotNumberUsedTotal": 7,
      "SnapshotCapacityUsedTotal": 5
    },
    "DiskOverview": {
      "ExpiredNumberTotal": 0,
      "DiskNumberTotal": 6,
      "DiskNumberUnderDataProtection": 4,
      "DiskNumberExpireIn7days": 0
    },
    "RequestId": "68b43d3a-3a20-39b9-3634-fc82992d361f",
    "ResourcesDetailSet": [
      {
        "ExpiredNumber": 0,
        "Region": "mock-region",
        "SnapshotNumberTotal": 448,
        "DiskNumberUnderDataProtection": 4,
        "DiskNumberExpireIn7days": 0,
        "SnapshotNumberUsed": 7,
        "SnapshotCapacityUsed": 5,
        "SnapshotSupportCrossCopy": true,
        "DiskNumber": 6,
        "SnapshotCapacityTotal": 50000,
        "NewDiskFlag": true,
        "DiskNumberIsolated": 0
      }
    ]
  }
}