查询企业计费使用情况
1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
通过此接口（DescribeBillUsageDetail）查询该企业的套餐消耗详情。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeBillUsageDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2020-11-11。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| StartTime | 是 | String | 查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天 示例值：20230101 |
| EndTime | 是 | String | 查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天 示例值：20230105 |
| Offset | 否 | Integer | 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0 示例值：0 |
| Limit | 否 | Integer | 指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。 示例值：50 |
| QuotaType | 否 | String | 查询的套餐类型 （选填 ）不传则查询所有套餐； 目前支持:
示例值：CloudEnterprise |
| Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 示例值：125 |
| Details | Array of BillUsageDetail | 消耗详情 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询全部套餐消耗
查询全部套餐消耗
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillUsageDetail
<公共请求参数>
{
"StartTime": "20230902",
"EndTime": "20230930",
"Offset": 0,
"Limit": 50
}
输出示例
{
"Response": {
"Details": [
{
"CostTime": 1695037514,
"CostType": 1,
"CreateOrganizationName": "典子谦示例企业",
"FlowId": "yDwFdUUckps******uzcbXwoXbRF6ja3",
"FlowName": "典子谦示例合同",
"OperatorName": "典子谦;张三",
"QuotaName": "企业版运营礼包",
"QuotaType": "CloudEnterprise",
"Remark": "",
"Status": 4,
"UseCount": 1
}
],
"RequestId": "s16992572741898xxxx",
"Total": 1
}
}
示例2 查询失败样例
调用参数错误，导致查询失败样例
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillUsageDetail
<公共请求参数>
{
"StartTime": "20230902",
"EndTime": "20230930",
"Offset": 0,
"Limit": 1000
}
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameter.Limit",
"Message": "分页参数不合法"
},
"RequestId": "s169935778xxxxxxx"
}
}
示例3 查询子企业客户消耗
查询子企业客户消耗
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillUsageDetail
<公共请求参数>
{
"StartTime": "20230902",
"EndTime": "20230930",
"Offset": 0,
"Limit": 50,
"Agent": {
"ProxyOrganizationId": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP"
}
}
输出示例
{
"Response": {
"Details": [
{
"CostTime": 1695037514,
"CostType": 1,
"CreateOrganizationName": "张三示例企业",
"FlowId": "yDwFdUUckps******xAhL7zuaIwkMth4",
"FlowName": "张三示业合同",
"OperatorName": "典子谦;张三",
"QuotaName": "企业版运营礼包",
"QuotaType": "CloudEnterprise",
"Remark": "",
"Status": 4,
"UseCount": 1
}
],
"RequestId": "s16992572741898xxxx",
"Total": 1
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter.Limit | Limit参数超出最大限制 |
| InvalidParameterValue.InvalidQuotaType | 非法的套餐类型 |
| InvalidParameterValue.InvalidTime | 非法的时间参数 |
| ResourceNotFound.NotExistApplication | 应用号不存在。 |