QueryEmbeddedInfo接口用于获取组织下的嵌入配置,包括最大嵌入数和已经嵌入数等。

请求参数

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

要执行的操作。取值:QueryEmbeddedInfo。

返回数据

名称 类型 示例值 描述
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。

Result Struct

组织下报表的嵌入信息。

Detail Struct

嵌入作品的统计信息。

DashboardOfflineQuery Integer 1

嵌入的自助取数数量。

Page Integer 1

嵌入的仪表板数量。

Report Integer 1

嵌入的电子表格数量。

EmbeddedCount Integer 3

当前已经嵌入报表的数量。

MaxCount Integer 500

最大可嵌入报表的数量。

Success Boolean true

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

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

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=QueryEmbeddedInfo
&<公共请求参数>

正常返回示例

XML格式

<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>
    <MaxCount>50</MaxCount>
    <EmbeddedCount>3</EmbeddedCount>
    <Detail>
        <Report>1</Report>
        <DashboardOfflineQuery>1</DashboardOfflineQuery>
        <Page>1</Page>
    </Detail>
</Result>

JSON格式

{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":{"MaxCount":"50","EmbeddedCount":"3","Detail":{"Report":"1","DashboardOfflineQuery":"1","Page":"1"}}}

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止,您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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