跳到主要内容

合同用量查询

1. 接口描述​

接口请求域名： essbasic.tencentcloudapi.com 。

此接口（DescribeUsage）用于获取第三方平台所有合作企业流量消耗情况。 注: 此接口每日限频2次，若要扩大限制次数,请提前与客服经理或邮件至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.AppId必填
StartDate是Date开始时间，例如：2021-03-21
EndDate是Date结束时间，例如：2021-06-21；
开始时间到结束时间的区间长度小于等于90天。
NeedAggregate否Boolean是否汇总数据，默认不汇总。
不汇总：返回在统计区间内第三方平台下所有企业的每日明细，即每个企业N条数据，N为统计天数；
汇总：返回在统计区间内第三方平台下所有企业的汇总后数据，即每个企业一条数据；
Limit否Integer单次返回的最多条目数量。默认为1000，且不能超过1000。
Offset否Integer偏移量，默认是0。
Operator否UserInfo暂未开放

3. 输出参数​

参数名称类型描述
TotalInteger用量明细条数
DetailsArray of UsageDetail用量明细
注意：此字段可能返回 null，表示取不到有效值。
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 第三方平台用量查询-需要汇总​

第三方平台用量查询-需要汇总

输入示例​

POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUsage
<公共请求参数>

{
    "StartDate": "2020-07-11",
    "EndDate": "2020-07-12",
    "Agent": {
        "AppId": "testappid1"
    },
    "NeedAggregate": true
}

输出示例​

{
    "Response": {
        "Total": 2,
        "Details": [
            {
                "Date": "2020-09-22",
                "ProxyOrganizationOpenId": "org1",
                "Usage": 100,
                "ProxyOrganizationName": "合作企业",
                "FlowChannel": "test",
                "Cancel": 0
            },
            {
                "Date": "2020-09-22",
                "ProxyOrganizationOpenId": "org2",
                "Usage": 166,
                "ProxyOrganizationName": "合作企业",
                "FlowChannel": "test",
                "Cancel": 0
            }
        ],
        "RequestId": "id"
    }
}

示例2 第三方平台用量查询查询-无需汇总​

第三方平台用量查询查询-无需汇总

输入示例​

POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUsage
<公共请求参数>

{
    "StartDate": "2020-07-11",
    "EndDate": "2020-07-12",
    "Agent": {
        "AppId": "testappid1"
    },
    "NeedAggregate": false
}

输出示例​

{
    "Response": {
        "Total": 4,
        "Details": [
            {
                "Date": "2020-07-11",
                "ProxyOrganizationOpenId": "org1",
                "Usage": 50,
                "ProxyOrganizationName": "合作企业",
                "FlowChannel": "test",
                "Cancel": 0
            },
            {
                "Date": "2020-07-12",
                "ProxyOrganizationOpenId": "org1",
                "Usage": 50,
                "ProxyOrganizationName": "合作企业",
                "FlowChannel": "test",
                "Cancel": 0
            },
            {
                "Date": "2020-07-11",
                "ProxyOrganizationOpenId": "org2",
                "Usage": 80,
                "ProxyOrganizationName": "合作企业",
                "FlowChannel": "test",
                "Cancel": 0
            },
            {
                "Date": "2020-07-12",
                "ProxyOrganizationOpenId": "org2",
                "Usage": 86,
                "ProxyOrganizationName": "合作企业",
                "FlowChannel": "test",
                "Cancel": 0
            }
        ],
        "RequestId": "id"
    }
}

5. 开发者资源​

腾讯云 API 平台​

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

API Inspector​

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

SDK​

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

命令行工具​

6. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.Api其他API错误。
InvalidParameter参数错误。
InvalidParameter.Date参数错误，不合法的日期，请检查后重试。
LimitExceeded.CallTimes超出调用次数限制。
MissingParameter缺少参数错误。
MissingParameter.Date缺少时间参数，请检查后重试。
OperationDenied操作被拒绝。
OperationDenied.BannedApplication应用号已被禁止。
OperationDenied.UserNotInOrganization用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。