产品概述
产品优势
产品功能
应用场景
Domain name for API request: bi.intl.tencentcloudapi.com.
This API is used to extend the available time of a token with strong authentication.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: ApplyEmbedInterval. |
| Version | Yes | String | Common Params. The value used for this API: 2022-01-05. |
| Region | No | String | Common Params. This parameter is not required. |
| ProjectId | No | Integer | Shares the project ID. |
| PageId | No | Integer | Shares the page ID. This field is empty (0) for embedding a dashboard and is not passed for embedding ChatBI. |
| BIToken | No | String | Token requiring extension. |
| ExtraParam | No | String | Alternate field. |
| Intention | No | String | embed: page/dashboard embedding. chatBIEmbed: ChatBI embedding. |
| Scope | No | String | panel: dashboard; page: page. project, during ChatBI embedding. |
| Parameter Name | Type | Description |
|---|---|---|
| ErrorInfo | ErrorInfo | Custom error information object. Note: This field may return null, indicating that no valid values can be obtained. |
| Extra | String | Additional parameters. Note: This field may return null, indicating that no valid values can be obtained. |
| Data | ApplyEmbedTokenInfo | Result data. Note: This field may return null, indicating that no valid values can be obtained. |
| Msg | String | Result description. Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: bi.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyEmbedInterval
<Common request parameters>
{
"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
}
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InternalError.Internal | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameter.Embed | Report embedding error. |
| InvalidParameterValue | Parameter value error. |
| MissingParameter | Parameters are missing. |
| MissingParameter.MissingParam | The required parameter is missing. |
| OperationDenied | Operation denied. |
| RequestLimitExceeded | Too many and frequent requests. |
| UnauthorizedOperation | Unauthorized operation. |
| UnauthorizedOperation.Authorize | Permission error. |
| UnknownParameter | Unknown parameter error. |
| UnsupportedOperation | The operation is not supported. |
| UnsupportedOperation.BIError | Default business exception. |
文档反馈