1. 接口描述
接口请求域名： partners.tencentcloudapi.com 。
代理商可查询自己及名下代客所有业务明细
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAgentBills。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-21。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| SettleMonth | 是 | String | 支付月份，如2018-02 示例值：2018-02 |
| ClientUin | 否 | String | 客户账号ID 示例值：2000002 |
| PayMode | 否 | String | 支付方式，prepay/postpay 示例值：prepay |
| OrderId | 否 | String | 预付费订单号 示例值：202400000122223 |
| ClientRemark | 否 | String | 客户备注名称 示例值：客户备注名称 |
| Offset | 否 | Integer | 偏移量 示例值：0 |
| Limit | 否 | Integer | 限制数目 示例值：3 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合查询条件列表总数量 示例值：2 |
| AgentBillSet | Array of AgentBillElem | 业务明细列表 示例值：[ { "ActivityId": "0", "Amt": 125, "ClientRemark": "有特批", "ClientType": "old", "ClientUin": "2000002", "GoodsType": "购买云服务", "OrderId": "202401311730494235252", "PayMode": "prepay", "PayTime": "2024-01-31 06:06:46", "PayerMode": "selfpay", "ProjectType": "platform", "SettleMonth": "2024-01", "Uin": "1000001" } ] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询代理商指定月份业务明细
查询某代理商2018年2月份业务明细
输入示例
https://partners.tencentcloudapi.com/?Action=DescribeAgentBills
&SettleMonth=2018-02
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 1,
"AgentBillSet": [
{
"ActivityId": "0",
"Amt": 125,
"ClientRemark": "有特批",
"ClientType": "old",
"ClientUin": "2000002",
"GoodsType": "购买云服务",
"OrderId": "202401311730494235252",
"PayMode": "prepay",
"PayTime": "2024-01-31 06:06:46",
"PayerMode": "selfpay",
"ProjectType": "platform",
"SettleMonth": "2024-01",
"Uin": "1000001"
}
],
"RequestId": "84a1e38a-95a1-4cc4-ac7d-232a2d872d45"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
