合同消耗数量查询
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
此接口（DescribeUsage）用于获取此应用下子客企业的合同消耗数量。
注: 此接口每日限频50次，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeUsage。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
|
| StartDate | 是 | Date | 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-03-21) 注: 查询日期范围区间长度大于90天。示例值：2021-03-21 |
| EndDate | 是 | Date | 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如：2021-04-21) 注: 查询日期范围区间长度大于90天。示例值：2021-04-22 |
| NeedAggregate | 否 | Boolean | 是否汇总数据，默认不汇总。
示例值：true |
| Limit | 否 | Integer | 指定每页返回的数据条数，和Offset参数配合使用。 注: 默认值为1000，单页做大值为1000 |
| Offset | 否 | Integer | 查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注： offset从0开始，即第一页为0。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 用量明细条数 |
| Details | Array of UsageDetail | 用量明细 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询明细消耗
NeedAggregate设置为false为查询明细消耗
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUsage
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"StartDate": "2023-11-06",
"EndDate": "2023-11-08",
"NeedAggregate": false,
"Limit": 1000,
"Offset": 0
}
输出示例
{
"Response": {
"Total": 4,
"Details": [
{
"ProxyOrganizationOpenId": "org_zhansan",
"ProxyOrganizationName": "张三示例企业",
"Date": "2023-11-06",
"Usage": 12,
"Cancel": 0,
"FlowChannel": "企业版"
},
{
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOrganizationName": "典子谦示例企业",
"Date": "2023-11-07",
"Usage": 30,
"Cancel": 0,
"FlowChannel": "企业版"
},
{
"ProxyOrganizationOpenId": "org_lisi",
"ProxyOrganizationName": "李四示例企业",
"Date": "2023-11-07",
"Usage": 0,
"Cancel": 5,
"FlowChannel": "企业版"
},
{
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOrganizationName": "典子谦示例企业",
"Date": "2023-11-08",
"Usage": 6,
"Cancel": 0,
"FlowChannel": "企业版"
}
],
"RequestId": "5f01d19e-d4dc-4e8b-b709-024132d16da9"
}
}
示例2 查询汇总消耗
NeedAggregate设置为true为查询汇总消耗
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUsage
<公共请求参数>
{
"Agent": {
"AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOperator": {
"OpenId": "n9527"
},
"ProxyAppId": ""
},
"StartDate": "2023-11-06",
"EndDate": "2023-11-08",
"NeedAggregate": true,
"Limit": 1000,
"Offset": 0
}
输出示例
{
"Response": {
"Total": 2,
"Details": [
{
"ProxyOrganizationOpenId": "org_zhangsan",
"ProxyOrganizationName": "张三实例企业",
"Date": "1970-01-01",
"Usage": 0,
"Cancel": 5,
"FlowChannel": "企业版"
},
{
"ProxyOrganizationOpenId": "org_dianziqian",
"ProxyOrganizationName": "典子谦示例企业",
"Date": "1970-01-01",
"Usage": 48,
"Cancel": 0,
"FlowChannel": "企业版"
}
],
"RequestId": "f6ad02ec-0399-46c8-a9d9-4dde2aedc036"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.Api | 其他API错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.Date | 参数错误，不合法的日期，请检查后重试。 |
| InvalidParameter.Limit | 参数Limit不正确 |
| LimitExceeded.CallTimes | 超出调用次数限制。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.Date | 缺少时间参数，请检查后重试。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.BannedApplication | 应用号已被禁止。 |
| OperationDenied.UserNotInOrganization | 用户不归属于当前企业，无法操作，请检查后重试。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.Application | 应用号不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |