帮你快速理解、总结文档立即下载

查询平台版资源用量

最近更新时间:2026-11-10 02:50:58
我的收藏

1. 接口描述

接口请求域名: tcb.tencentcloudapi.com 。

查询指定平台版(云开发)环境的资源使用情况。支持指定查询时间范围(起始/结束日期),按资源类型返回各资源指标的用量及用量明细(按天)。
用量信息包含:
资源点用量(Credits):该指标/资源折算后的计费资源点数;
原始用量值(UsageValue):如流量、调用次数、容量等实际用量;
原始用量单位(UsageUnit):如次、Byte、MB、GBs、核秒、QPS 等;
按天用量明细(DailyUsageList):包含每天日期、当日用量值及当日资源点。
影响范围 只读查询,不改变任何资源状态。
使用场景 控制台「用量」页面 / 开放 API 查询平台版环境用量。
数据实时性说明 本接口返回的是已结算用量,并非秒级实时监控数据,各指标的更新粒度与数据延迟如下:
存储容量类指标(如 Capacity、EnvAllocatedCapacity、Storage)按"自然日"统计,通常在次日凌晨完成前一日核算后才刷新;查询当日的值往往还未最终结算或显示为预估/0,需次日才能查询到完整数据。
计算与调用类指标(如 Invocation、ReadRequests、WriteRequests、MemoryUse、Ccu、CPU、Mem 等)按小时聚合,隔天进行计算落库;查询范围的汇总值可能包含当日实时累计,而按天明细只包含已结算的历史完整日。
流量类指标(如 Flux、Outflow、CDN/CI 流量等)中,云存储、CDN 流量多按天结算,云函数外网出流量按小时,均存在最多约 1 天的对账延迟。
资源点(Credits)不是独立实时计数,而是由原始用量按 CreditsScale 换算而来,折算随底层原始指标一起更新;免费额度内的消耗通常显示为 0。
按天用量明细(DailyUsageList)只返回已结算的完整日数据,当前进行中的当日一般不会完整出现在列表中;而指标层级的汇总字段 UsageValue 可能已包含当日实时累计,二者统计口径不同,不能简单相加比对。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribePlatformEnvUsage。
Version 是 String 公共参数,本接口取值:2018-06-08。
Region 否 String 公共参数,本接口不需要传递此参数。
EnvId 是 String

环境Id


示例值:jeff-d4g6izo8z6a0502f6
StartDate 否 String

查询用量起始时间

参数格式:YYYY-MM-DD


示例值:2026-08-20
EndDate 否 String

查询用量结束时间

参数格式:YYYY-MM-DD


示例值:2026-09-20
ResourceTypes.N 否 Array of String

资源类型

枚举值:

  • Storage: 云存储
  • Function: 云函数
  • Database: 数据库

示例值:["Database"]
NeedUsageDetails 否 Boolean

是否展示用量明细


示例值:true

3. 输出参数

参数名称 类型 描述
Resources Array of PlatformResUsageItem

资源用量信息

TotalCredits Integer

资源点


示例值:595100
CreditsScale Integer

资源点取整倍数


示例值:10000
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询环境资源用量

输入示例

POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePlatformEnvUsage
<公共请求参数>

{
    "EnvId": "jeff-d4g6izo8z6a0502f6",
    "StartDate": "2026-08-20",
    "EndDate": "2026-09-20",
    "ResourceTypes": [
        "Storage"
    ],
    "NeedUsageDetails": true
}

输出示例

{
    "Response": {
        "CreditsScale": 10000,
        "Resources": [
            {
                "Metrics": [
                    {
                        "Credits": 50000,
                        "DailyUsageList": [
                            {
                                "Credits": 50000,
                                "Date": "2026-09-08",
                                "UsageValue": 5000
                            }
                        ],
                        "MetricName": "ReadRequests",
                        "OriginalMetricName": "ReadRequests",
                        "OriginalResourceType": "COS",
                        "UsageUnit": "Count",
                        "UsageValue": 5000
                    }
                ],
                "ResourceType": "Storage",
                "TotalCredits": 100000
            }
        ],
        "TotalCredits": 100000,
        "RequestId": "b847eba1-a5b0-4f2a-b978-cc0389ca5141"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。