接口请求域名： bi.intl.tencentcloudapi.com 。
申请延长Token可用时间接口-强鉴权
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ApplyEmbedInterval。 |
| Version | 是 | String | 公共参数，本接口取值：2022-01-05。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ProjectId | 否 | Integer | 分享项目id |
| PageId | 否 | Integer | 分享页面id，嵌出看板时此为空值0，ChatBI嵌出时不传 |
| BIToken | 否 | String | 需要申请延期的Token |
| ExtraParam | 否 | String | 备用字段 |
| Intention | 否 | String | embed：页面/看板嵌出 chatBIEmbed：ChatBI嵌出 |
| Scope | 否 | String | panel, 看板；page，页面 project，ChatBI嵌出时 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ErrorInfo | ErrorInfo | 自定义错误信息对象 注意：此字段可能返回 null，表示取不到有效值。 |
| Extra | String | 额外参数 注意：此字段可能返回 null，表示取不到有效值。 |
| Data | ApplyEmbedTokenInfo | 结果数据 注意：此字段可能返回 null，表示取不到有效值。 |
| Msg | String | 结果描述 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: bi.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyEmbedInterval
<公共请求参数>
{
"ProjectId": 1982493789748932,
"PageId": 1982493789748932,
"BIToken": "BIToken",
"ExtraParam": "ExtraParam",
"Intention": "Intention",
"Scope": "Scope"
}
{
"Response": {
"Msg": "success",
"RequestId": "e60a2172-715b-4305-beb2-40792ae53856",
"Extra": "",
"Data": {
"Result": true
}
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.Internal | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.Embed | 报表嵌出类错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.MissingParam | 必填参数缺失。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.Authorize | 权限错误。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.BIError | 默认业务异常。 |
文档反馈