跳到主要内容

查询企业套餐使用情况

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. 输出参数​

参数名称类型描述
SummaryArray of OrgBillSummary企业套餐余额及使用情况
SubOrgSummaryArray of SubOrgBillSummary集团子企业套餐使用情况
RequestIdString唯一请求 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. 错误码​

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

错误码描述
FailedOperation操作失败。
InvalidParameterValue.InvalidQuotaType非法的套餐类型
InvalidParameterValue.InvalidTime非法的时间参数
更多开发者交流反馈