合同消耗数量查询

1. 接口描述

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

此接口（DescribeUsage）用于获取此应用下子客企业的合同消耗数量。

注: 此接口每日限频50次，若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。

默认接口请求频率限制：20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

3. 输出参数

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. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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