开发指南

API 文档

查询环境的配额使用量

最近更新时间:2021-02-04 08:32:45

我的收藏

1. 接口描述

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

查询指定指标的配额使用量

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeQuotaData。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,本接口不需要传递此参数。
EnvId String 环境ID
MetricName String
  • 指标名:
  • StorageSizepkg: 当月存储空间容量, 单位MB
  • StorageReadpkg: 当月存储读请求次数
  • StorageWritepkg: 当月存储写请求次数
  • StorageCdnOriginFluxpkg: 当月CDN回源流量, 单位字节
  • StorageCdnOriginFluxpkgDay: 当日CDN回源流量, 单位字节
  • StorageReadpkgDay: 当日存储读请求次数
  • StorageWritepkgDay: 当日写请求次数
  • CDNFluxpkg: 当月CDN流量, 单位为字节
  • CDNFluxpkgDay: 当日CDN流量, 单位为字节
  • FunctionInvocationpkg: 当月云函数调用次数
  • FunctionGBspkg: 当月云函数资源使用量, 单位MbMs
  • FunctionFluxpkg: 当月云函数流量, 单位千字节(KB)
  • FunctionInvocationpkgDay: 当日云函数调用次数
  • FunctionGBspkgDay: 当日云函数资源使用量, 单位MbMs
  • FunctionFluxpkgDay: 当日云函数流量, 单位千字节(KB)
  • DbSizepkg: 当月数据库容量大小, 单位MB
  • DbReadpkg: 当日数据库读请求数
  • DbWritepkg: 当日数据库写请求数
  • StaticFsFluxPkgDay: 当日静态托管流量
  • StaticFsFluxPkg: 当月静态托管流量
  • StaticFsSizePkg: 当月静态托管容量
  • TkeCpuUsedPkg: 当月容器托管CPU使用量,单位核
  • TkeCpuUsedPkgDay: 当天容器托管CPU使用量,单位核
  • TkeMemUsedPkg: 当月容器托管内存使用量,单位MB
  • TkeMemUsedPkgDay: 当天容器托管内存使用量,单位MB
  • CodingBuildTimePkgDay: 当天容器托管构建时间使用量,单位毫秒
  • TkeHttpServiceNatPkgDay: 当天容器托管流量使用量,单位B
  • ResourceID String 资源ID, 目前仅对云函数、容器托管相关的指标有意义。云函数(FunctionInvocationpkg, FunctionGBspkg, FunctionFluxpkg)、容器托管(服务名称)。如果想查询某个云函数的指标则在ResourceId中传入函数名; 如果只想查询整个namespace的指标, 则留空或不传。

    3. 输出参数

    参数名称 类型 描述
    MetricName String 指标名
    Value Integer 指标的值
    SubValue String 指标的附加值信息
    注意:此字段可能返回 null,表示取不到有效值。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询指定指标的配额使用量

    输入示例

    https://tcb.tencentcloudapi.com/?Action=DescribeQuotaData
    &EnvId=test-23
    &MetricName=DbWritepkg
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "MetricName": "DbWritepkg",
        "RequestId": "548c46c8-a177-4e39-820a-b544b3fd48c6",
        "Value": 0,
        "SubValue": "100"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    MissingParameter 缺少参数错误。
    MissingParameter.Param 缺少必要参数。
    ResourceNotFound 资源不存在。
    ResourceUnavailable 资源不可用。
    目录