1. 接口描述
接口请求域名: bi.tencentcloudapi.com 。
页面截图导出
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ExportScreenPage。 |
Version | 是 | String | 公共参数,本接口取值:2022-01-05。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ProjectId | 是 | String | 项目id 示例值:110101 |
PageId | 是 | String | 页面id 示例值:1 |
CanvasType | 否 | String | 画布类型。栅格画布:GRID;自由画布:FREE 示例值:"GRID" |
PicType | 否 | String | 图片导出类型。base64;url(有效期:1天) 示例值:"base64" |
WidgetIds.N | 否 | Array of String | 组件Ids。为空时,导出整个页面 示例值:["123","456"] |
AsyncRequest | 否 | Boolean | 是否是异步请求 示例值:true |
TranId | 否 | String | 事务id 示例值:dsa21192912 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ErrorInfo | ErrorInfo | 自定义错误信息对象 注意:此字段可能返回 null,表示取不到有效值。 |
Extra | String | 扩展参数 注意:此字段可能返回 null,表示取不到有效值。 示例值:"ext" |
Data | PageScreenListVO | 返回数据结果 注意:此字段可能返回 null,表示取不到有效值。 |
Msg | String | 返回消息 注意:此字段可能返回 null,表示取不到有效值。 示例值:"success" |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 导出自由画布
导出自由画布
输入示例
POST / HTTP/1.1
Host: bi.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportScreenPage
<公共请求参数>
{
"ProjectId": "1907",
"PageId": "39618",
"CanvasType": "FREE",
"PicType": "url",
"WidgetIds": []
}
输出示例
{
"Response": {
"ErrorInfo": {
"ErrorTip": "",
"ErrorMessage": "接口错误",
"ErrorLevel": "ERROR",
"DocLink": "",
"FAQ": "",
"ReservedField": ""
},
"Extra": "",
"Data": {
"PicType": "PNG",
"List": [
{
"Content": "",
"WidgetId": "saia192"
}
],
"TranId": "qwq211221",
"TranStatus": 0
},
"Msg": "失败",
"RequestId": "ddsds122321-fdsd12"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.Internal | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
MissingParameter.MissingParam | 必填参数缺失。 |
UnsupportedOperation.BIError | 默认业务异常。 |