查询企业套餐使用情况

最近更新时间:2025-05-15 01:34:15

我的收藏

1. 接口描述

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

通过此接口(DescribeBillUsage)查询该企业的套餐套餐使用情况。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBillUsage。
Version String 公共参数,本接口取值:2020-11-11。
Region String 公共参数,此参数为可选参数。
StartTime String 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于90天
示例值:20230101
EndTime String 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于90天
示例值:20230105
QuotaType String 查询的套餐类型 (选填 )不传则查询所有套餐;目前支持:
  • CloudEnterprise: 企业版合同
  • SingleSignature: 单方签章
  • CloudProve: 签署报告
  • CloudOnlineSign: 腾讯会议在线签约
  • ChannelWeCard: 微工卡
  • SignFlow: 合同套餐
  • SignFace: 签署意愿(人脸识别)
  • SignPassword: 签署意愿(密码)
  • SignSMS: 签署意愿(短信)
  • PersonalEssAuth: 签署人实名(腾讯电子签认证)
  • PersonalThirdAuth: 签署人实名(信任第三方认证)
  • OrgEssAuth: 签署企业实名
  • FlowNotify: 短信通知
  • AuthService: 企业工商信息查询

示例值:CloudEnterprise
DisplaySubEnterprise Boolean 是否展示集团子企业的明细,默认否
示例值:true

3. 输出参数

参数名称 类型 描述
Summary Array of OrgBillSummary 企业套餐余额及使用情况
SubOrgSummary Array of SubOrgBillSummary 集团子企业套餐使用情况
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询企业版合同套餐使用

输入示例

复制
复制成功
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillUsageDetail
<公共请求参数>

{
    "StartTime": "20240901",
    "EndTime": "20240930",
    "QuotaType": "CloudEnterprise"
}

输出示例

复制
复制成功
{
    "Response": {
        "RequestId": "s1729129053894358080",
        "SubOrgSummary": [],
        "Summary": [
            {
                "Available": 9967,
                "QuotaType": "CloudEnterprise",
                "Total": 412505,
                "Used": 32
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameterValue.InvalidQuotaType 非法的套餐类型
InvalidParameterValue.InvalidTime 非法的时间参数

如果遇到产品相关问题,您可咨询 在线客服寻求帮助。

返回顶部