查询渠道计费消耗情况
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
通过此接口（ChannelDescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。可以支持单个子客和整个应用下所有子客的查询。
- 对于单个子客企业的查询，通过指定子客的唯一标识(Agent.ProxyOrganizationOpenId)来查询该子客消耗详情
- 对于整个应用下所有企业的查询，不需要指定子客的唯一标识，只需要传入渠道应用标识(Agent.AppId)直接查询整个应用下所有子客企业消耗详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ChannelDescribeBillUsageDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业必须已经经过实名认证 |
| StartTime | 是 | String | 查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天 示例值：20231101 |
| EndTime | 是 | String | 查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天 示例值：20231108 |
| QuotaType | 否 | String | 查询的套餐类型 （选填 ）不传则查询所有套餐； 目前支持:
示例值：CloudEnterprise |
| Offset | 否 | Integer | 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0 示例值：0 |
| Limit | 否 | Integer | 指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 返回查询记录总数 示例值：100 |
| Details | Array of ChannelBillUsageDetail | 消耗记录详情 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询失败样例
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelDescribeBillUsageDetail
<公共请求参数>
{
"StartTime": "20230902",
"EndTime": "20230930",
"Offset": 0,
"Limit": 500,
"Agent": {
"AppId": "yDwFdUUckpsw******yQ0af8bHosXQtb",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
}
}
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameter.Limit",
"Message": "分页参数不合法"
},
"RequestId": "s169935778xxxxxxx"
}
}
示例2 查询某应用下渠道企业的消耗情况
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelDescribeBillUsageDetail
<公共请求参数>
{
"StartTime": "20230902",
"EndTime": "20230930",
"Offset": 0,
"Limit": 20,
"Agent": {
"AppId": "yDwFdUUckpsw******yQ0af8bHosXQtb"
}
}
输出示例
{
"Response": {
"Details": [
{
"CostTime": 1695037514,
"CostType": 1,
"CreateOrganizationName": "典子谦示例企业",
"FlowId": "yDwFdUUckps******uzcbXwoXbRF6ja3",
"FlowName": "典子谦示例合同",
"OperatorName": "张三;典子谦",
"QuotaName": "企业版运营礼包",
"QuotaType": "CloudEnterprise",
"Remark": "",
"FlowStatus": "ALL",
"UseCount": 1
}
],
"RequestId": "s16992572741898xxxx",
"Total": 1
}
}
示例3 查询某个应用下某个子客的消耗情况
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelDescribeBillUsageDetail
<公共请求参数>
{
"StartTime": "20230902",
"EndTime": "20230930",
"Offset": 0,
"Limit": 20,
"Agent": {
"AppId": "yDwFdUUckpsw******yQ0af8bHosXQtb",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
}
}
输出示例
{
"Response": {
"Details": [
{
"CostTime": 1695037514,
"CostType": 1,
"CreateOrganizationName": "典子谦示例企业",
"FlowId": "yDwFdUUckps******uzcbXwoXbRF6ja3",
"FlowName": "典子谦示例合同",
"OperatorName": "张三;典子谦",
"QuotaName": "企业版运营礼包",
"QuotaType": "CloudEnterprise",
"Remark": "",
"FlowStatus": "ALL",
"UseCount": 1
}
],
"RequestId": "s16992572741898xxxx",
"Total": 1
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InvalidParameter.Limit | 参数Limit不正确 |
| InvalidParameterValue.InvalidQuotaType | 非法的套餐类型 |
| InvalidParameterValue.InvalidTime | 非法的时间参数 |
| ResourceNotFound.NotExistApplication | 应用号不存在 |