1. 接口描述
接口请求域名： bi.tencentcloudapi.com 。
创建嵌出报表-强鉴权
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateEmbedToken。 |
| Version | 是 | String | 公共参数，本接口取值：2022-01-05。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ProjectId | 否 | Integer | 分享项目id 示例值：1 |
| PageId | 否 | Integer | 分享页面id，嵌出看板时此为空值0 示例值：1 |
| Scope | 否 | String | page表示嵌出页面，panel表嵌出整个看板 示例值：1 |
| ExpireTime | 否 | String | 过期时间。 单位：分钟 最大值：240。即，4小时 默认值：240 示例值：1 |
| ExtraParam | 否 | String | 备用字段 示例值：1 |
| UserCorpId | 否 | String | 使用者企业Id(仅用于多用户) |
| UserId | 否 | String | 使用者Id(仅用于多用户) |
| TicketNum | 否 | Integer | 访问次数限制，限制范围1-99999，为空则不设置访问次数限制 示例值：1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ErrorInfo | ErrorInfo | 自定义错误信息对象 注意：此字段可能返回 null，表示取不到有效值。 |
| Extra | String | 额外信息 注意：此字段可能返回 null，表示取不到有效值。 示例值："" |
| Data | EmbedTokenInfo | 数据 注意：此字段可能返回 null，表示取不到有效值。 |
| Msg | String | 结果描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：success |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 报表嵌出创建Token接口示例-强鉴权
报表嵌出创建Token接口示例
输入示例
POST / HTTP/1.1
Host: bi.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEmbedToken
<公共请求参数>
{
"ExpireTime": "10",
"Scope": "panel",
"ExtraParam": "",
"ProjectId": "1",
"UserCorpId": "",
"UserId": "",
"TicketNum": 0
}输出示例
{
"Response": {
"Msg": "success",
"RequestId": "adfacf71-c59c-4569-897d-955a1e41ee89",
"Extra": "",
"Data": {
"Id": 11,
"ProjectId": "1",
"PageId": null,
"ExtraParam": "",
"Scope": "panel",
"ExpireTime": 10,
"CreatedUser": null,
"CreatedAt": "2022-04-28 14:26:01",
"UpdatedUser": null,
"UpdatedAt": "2022-04-28 14:26:01",
"BIToken": "300cf2a4-cfb8-47b8-9bc0-4a1f1f74bc1d",
"UserCorpId": "",
"UserId": "",
"TicketNum": 0
}
}
}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签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.Internal | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.Embed | 报表嵌出类错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.MissingParam | 必填参数缺失。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.Authorize | 权限错误。 |
| UnauthorizedOperation.UserNotExist | 用户不存在。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.BIError | 默认业务异常。 |