1. 接口描述
接口请求域名: cds.tencentcloudapi.com 。
查询报表列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeReportList。 |
| Version | 是 | String | 公共参数,本接口取值:2018-04-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Limit | 否 | Integer | 限制数目 示例值:0 |
| Offset | 否 | Integer | 偏移量 示例值:0 |
| Name | 否 | String | 报告名称 示例值:'' |
| StartTime | 否 | Integer | 开始时间 示例值:0 |
| EndTime | 否 | Integer | 结束时间 示例值:0 |
| ReportType | 否 | Integer | 报告类型 示例值:0 |
| ReportStatus | 否 | Integer | 报告状态 示例值:0 |
| TemplateId | 否 | Integer | 报表模版id 示例值:0 |
| Field | 否 | String | 需要排序的字段 示例值:'' |
| Sort | 否 | String | 排序顺序 asc desc 示例值:'' |
| CntDay | 否 | Integer | 时间范围 1:24小时 7:近一周 30:近30天 90:近90天 180:近180天 不变更为0 示例值:0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数目 示例值:100 |
| List | Array of Reports | 数据列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询报表列表
输入示例
POST / HTTP/1.1
Host: cds.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeReportList
<公共请求参数>
{
"Limit": 0,
"Offset": 0,
"Name": "abc",
"StartTime": 0,
"EndTime": 0,
"ReportType": 0,
"ReportStatus": 0,
"TemplateId": 0,
"Field": "abc",
"Sort": "abc",
"CntDay": 0
}
输出示例
{
"Response": {
"TotalCount": 0,
"List": [
{
"AddTime": 0,
"EndTime": 0,
"Id": 0,
"InstanceId": 0,
"IsDelete": 0,
"Receivers": "abc",
"Remark": "abc",
"ReportFile": "abc",
"ReportStatus": 0,
"ReportTmpStatus": 0,
"ReportType": 0,
"SendResult": "abc",
"SendType": "abc",
"StartTime": 0,
"Title": "abc",
"TemplateId": 0,
"AssetsList": [
{
"AddTime": 1,
"Aid": 1,
"AssetsIp": "abc",
"AssetsName": "abc",
"AssetsPort": 1,
"AssetsType": "abc",
"AssetsVersion": "abc",
"AssetsAddType": 1,
"Status": 1,
"UpdateTime": 1,
"VpcId": "abc",
"RegionId": "abc",
"Permission": 0,
"InstanceId": "abc",
"InstanceName": "abc",
"AddType": 1,
"AssetSubnetId": "abc",
"UploadPem": 0,
"AliveStatus": 0,
"AgentOn": 1,
"CasbOn": 1,
"GroupId": "abc",
"Available": "abc",
"CdbOn": 1,
"DbPlatform": "abc",
"DbCharset": "abc",
"OsPolicy": "abc",
"BidirectionOn": 0,
"BidirectionMaxLine": 0,
"BidirectionMaxStorage": 0,
"BidirectionAllow": 0,
"BidirectionDelivery": 1,
"RoStatus": "abc"
}
],
"CntDay": 0
}
],
"RequestId": "abc"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.DasbAmountNotEnough | 账户余额不足,操作失败。 |
| FailedOperation.DasbErrorCode | Dasb产品操作失败错误码。 |
| FailedOperation.DasbInvalidSecretId | SecretId错误,操作失败。 |
| FailedOperation.DasbInvalidSecretKey | SecretKey错误,操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ResourceId | 无效的资源ID,用于资源不存在或已过期。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded | 超过配额限制。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.NoPermission | 无操作权限。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |