聚鑫-账单下载

最近更新时间:2020-01-02 16:53:44

1. 接口描述

接口请求域名: cpdp.tencentcloudapi.com 。

账单下载接口,根据本接口返回的URL地址,在D+1日下载对账单。注意,本接口返回的URL地址有时效,请尽快下载。URL超时时效后,请重新调用本接口再次获取。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DownloadBill
Version String 公共参数,本接口取值:2019-08-20
Region String 公共参数,详见产品支持的 地域列表
StateDate String 请求下载对账单日期
MidasAppId String 聚鑫分配的MidasAppId
MidasSecretId String 聚鑫分配的SecretId
MidasSignature String 使用聚鑫安全密钥计算的签名

3. 输出参数

参数名称 类型 描述
FileName String 账单文件名
FileMD5 String 账单文件的MD5值
DownloadUrl String 账单文件的真实下载地址
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 下载对账单请求示例

本接口提供对账单下载功能。调用者根据本接口返回的URL地址,在D+1日下载对账单。注意,本接口返回的URL地址有时效,请尽快下载。URL超时时效后,请重新调用本接口再次获取。

输入示例

https://cpdp.tencentcloudapi.com/?Action=DownloadBill
&<公共请求参数>
&StateDate=20191202
&MidasAppId=test_midas_app_id
&MidasSecretId=your_midas_secret_id
&MidasSignature=your_midas_signature

输出示例

{
  "FileName": "appid_20191202.csv",
  "FileMD5": "bef046b73c9e543f7773692ce56def68",
  "DownloadUrl": "download_url",
  "RequestId": "0c929116-67b6-4396-9d55-ba4a9113822d"
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ConfigError 下载服务器配置错误。
FailedOperation.DBConfigError 下载服务器数据库配置错误。
FailedOperation.FileNotExist 对账文件不存在,尚未生成。
FailedOperation.ServiceError 接口执行失败
FailedOperation.Unknown 未知错误
InvalidParameter 参数错误