QueryEmbedTokenInfo接口用于获取免登嵌入报表的指定token的详情信息。

说明 :只返回有效期内的token详情,过期或者不存在,会抛错。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryEmbedTokenInfo

要执行的操作。取值:QueryEmbedTokenInfo

Token String 243fa7d45c09b355eb7f****4785

要查询的token。

返回数据

名称 类型 示例值 描述
RequestId String 1FC71085-D5FD-08E0-813A-4D4BD1031BC5

请求ID。

Result Object

token的详细信息。

AccessToken String 243fa7d45c09b355eb7f****4785

token值。

TokeType Long 4

token类型。(报表嵌入的token类型,统一为4,不可更改)

InvalidTime String 2021-09-26 21:32:15

过期时间。

RegisterTime String 2021-09-26 17:08:38

注册时间。

Success Boolean true

是否请求成功。取值范围:

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=QueryEmbedTokenInfo
&Token=243fa7d45c09b355eb7f****4785
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryEmbedTokenInfoResponse>
    <RequestId>1FC71085-D5FD-08E0-813A-4D4BD1031BC5</RequestId>
    <Result>
        <AccessToken>243fa7d45c09b355eb7f****4785</AccessToken>
        <TokeType>4</TokeType>
        <InvalidTime>2021-09-26 21:32:15</InvalidTime>
        <RegisterTime>2021-09-26 17:08:38</RegisterTime>
    </Result>
    <Success>true</Success>
</QueryEmbedTokenInfoResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1FC71085-D5FD-08E0-813A-4D4BD1031BC5",
  "Result" : {
    "AccessToken" : "243fa7d45c09b355eb7f****4785",
    "TokeType" : 4,
    "InvalidTime" : "2021-09-26 21:32:15",
    "RegisterTime" : "2021-09-26 17:08:38"
  },
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
500 Internal.System.Error An internal system error occurred. 系统内部异常。
500 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Authorize3Rd.Token.NotExist The token [%s] does not exist. token不存在:[%s]。
500 Authorize3Rd.Token.Expired The token [%s] has expired. token 已经过期: [%s]。
500 NoPermissionTo.Operate.Object You are not authorized to operate the objects. 工作空间与组织 不符。

访问错误中心查看更多错误码。