本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # GetDashboardEmbedUrl 生成可用于嵌入 Amazon 的临时会话 URL 和授权码（持有者令牌） QuickSight 您的网站或应用程序中的只读仪表板。在使用此命令之前，请确保您已配置控制面板和权限。目前，您可以使用`GetDashboardEmbedURL`只能来自服务器，而不是来自用户的浏览器。以下规则适用于生成的 URL： + 它们必须一起使用。 + 它们只能使用一次。 + 在发出请求后的 5 分钟内有效。 + 只有在使用 URL 或与亚马逊进行互动时，您才需要付费 QuickSight. + 生成的用户会话有效期为 15 分钟（默认），最长 10 小时（最长）。您可以使用可选的`SessionLifetimeInMinutes`参数自定义会话持续时间。有关更多信息，请参阅。[使用嵌入分析 GetDashboardEmbedUrl](https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html)中的*亚马逊 QuickSight 用户指南*. 有关嵌入的高级步骤的详细信息以及自定义嵌入方式的交互式演示，请访问[亚马逊 QuickSight 开发人员门户](https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html). ## 请求语法 ``` GET /accounts/{{AwsAccountId}}/dashboards/{{DashboardId}}/embed-url?additional-dashboard-ids={{AdditionalDashboardIds}}&creds-type={{IdentityType}}&namespace={{Namespace}}&reset-disabled={{ResetDisabled}}&session-lifetime={{SessionLifetimeInMinutes}}&state-persistence-enabled={{StatePersistenceEnabled}}&undo-redo-disabled={{UndoRedoDisabled}}&user-arn={{UserArn}} HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [AdditionalDashboardIds](#API_GetDashboardEmbedUrl_RequestSyntax) ** 您希望匿名用户临时访问的一个或多个仪表板 ID 的列表。目前，`IdentityType`参数必须设置为`ANONYMOUS`因为其他身份类型认证为亚马逊 QuickSight 或 IAM 用户。例如，如果您设置”`--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS`“，会话可以访问所有三个仪表板。数组成员：最少 1 项。最多 20 项。长度限制：最小长度为 1。长度上限为 2048。模式：`[\w\-]+` ** [AwsAccountId](#API_GetDashboardEmbedUrl_RequestSyntax) ** 用于的IDAWS 账户包含您要嵌入的仪表板。长度限制：固定长度为 12。模式：`^[0-9]{12}$` 必需：是 ** [DashboardId](#API_GetDashboardEmbedUrl_RequestSyntax) ** 控制面板的 ID，也添加到AWS Identity and Access Management(IAM) 策略。长度限制：最小长度为 1。长度上限为 2048。模式：`[\w\-]+` 必需：是 ** [IdentityType](#API_GetDashboardEmbedUrl_RequestSyntax) ** 用户用于登录的身份验证方法。有效值:` IAM | QUICKSIGHT | ANONYMOUS` 必需：是 ** [Namespace](#API_GetDashboardEmbedUrl_RequestSyntax) ** Amazon QuickSight 包含此请求中的仪表板 ID 的命名空间。如果您没有使用自定义命名空间，请设置`Namespace = default`. 长度限制：最大长度为 64。模式：`^[a-zA-Z0-9._-]*$` ** [ResetDisabled](#API_GetDashboardEmbedUrl_RequestSyntax) ** 移除嵌入式控制面板上的重置按钮。默认值为 FALSE，表示启用重置按钮。 ** [SessionLifetimeInMinutes](#API_GetDashboardEmbedUrl_RequestSyntax) ** 会话的有效时长（以分钟为单位）。会话生命周期必须为 15-600 分钟。有效范围：最小值为 15。最大值为 600。 ** [StatePersistenceEnabled](#API_GetDashboardEmbedUrl_RequestSyntax) ** 在嵌入式仪表板中为用户会话添加状态的持久性。持久性适用于工作表和参数设置。这些是控制面板订阅者（亚马逊）的控制设置 QuickSight reader）在查看仪表板时进行选择。如果此值设置为`TRUE`，当订阅者重新打开相同的仪表板 URL 时，设置相同。状态存储在Amazon QuickSight，而不是在浏览器 cookie 中。如果将其设置为 FALSE，则不会保留用户会话的状态。默认为 `FALSE`。 ** [UndoRedoDisabled](#API_GetDashboardEmbedUrl_RequestSyntax) ** 移除嵌入式控制面板上的撤消/重做按钮。默认值为 FALSE，即启用撤消/重做按钮。 ** [UserArn](#API_GetDashboardEmbedUrl_RequestSyntax) ** Amazon QuickSight 用户的 Amazon 资源名称 (ARN)，用于与`QUICKSIGHT`身份类型。你可以将它用于任何亚马逊 QuickSight 您账户中的用户（读者、作者或管理员）以下列身份进行身份验证的 II 账户（读者、作者或管理员）： + Active Directory (AD) 用户或组成员 + 受邀的非联合用户 + 使用 SAML、OpenID Connect 或 IAM 联合，通过联合单点登录进行身份验证的 IAM 用户和基于 IAM 角色的用户和基于 IA 为第三个组（IAM 用户和基于角色的 IAM 会话）中的用户省略此参数。 ## 请求正文该请求没有请求体。 ## 响应语法 ``` HTTP/1.1 {{Status}} Content-type: application/json { "EmbedUrl": "string", "RequestId": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 响应。 ** [Status](#API_GetDashboardEmbedUrl_ResponseSyntax) ** 请求的 HTTP 状态。服务以 JSON 格式返回的以下数据。 ** [EmbedUrl](#API_GetDashboardEmbedUrl_ResponseSyntax) ** 您可以将其放入服务器端网页以嵌入仪表板的一次性网址。此 URL 的有效时间为 5 分钟。API 操作为 URL 提供了一个`auth_code`值，该值允许一个（且仅一次）登录有效期为 10 小时的用户会话。类型: 字符串 ** [RequestId](#API_GetDashboardEmbedUrl_ResponseSyntax) ** 这些区域有：AWS用于此操作的请求 ID。类型: 字符串 ## 错误有关所有操作常见错误的信息，请参阅[常见错误](CommonErrors.md). ** AccessDeniedException ** 您无权访问此项目。无法验证提供的凭证。您可能无权执行请求。确保您的账户已获得使用亚马逊的授权 QuickSight 服务，您的策略具有正确的权限，并且您使用的是正确的访问密钥。 HTTTP 状态代码：401 ** DomainNotWhitelistedException ** 指定的域不在允许列表中。Amazon 必须将嵌入控制面板的所有域添加到已批准列表 QuickSight admin。 HTTTP 状态代码：403 ** IdentityTypeNotSupportedException ** 指定的身份类型不受支持。支持的身份类型包括`IAM`和`QUICKSIGHT`. HTTTP 状态代码：403 ** InternalFailureException ** 出现内部故障。 HTTTP 状态代码：500 ** InvalidParameterValueException ** 一个或多个参数的值无效。 HTTTP 状态代码：400 ** QuickSightUserNotFoundException ** 未找到具有所提供名称的用户。此错误可能发生在需要基于提供的用户名查找用户的任何操作中，如`DeleteUser`、`DescribeUser`等等。 HTTTP 状态代码：404 ** ResourceExistsException ** 已存在指定的资源。 HTTTP 状态代码：409 ** ResourceNotFoundException ** 无法找到一个或多个资源。 HTTTP 状态代码：404 ** SessionLifetimeInMinutesInvalidException ** 为会话生命周期指定的分钟数无效。会话生命周期必须为 15-600 分钟。 HTTTP 状态代码：400 ** ThrottlingException ** 访问受限。 HTTTP 状态代码：429 ** UnsupportedPricingPlanException ** 此错误表示您正在调用 Amazon 中的嵌入操作 QuickSight没有您所需的定价计划AWSaccount. 在对匿名用户使用嵌入之前， QuickSight 管理员需要向亚马逊添加容量定价 QuickSight. 您可通过实现此目的**管理Amazon QuickSight**页. 添加容量定价后，您可以使用` [GetDashboardEmbedUrl](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html) `使用的 API 操作`--identity-type ANONYMOUS`选项。 HTTTP 状态代码：403 ** UnsupportedUserEditionException ** 此错误指示您正在 Amazon 上调用某个操作 QuickSight该版本不支持该操作的订阅。Amazon a QuickSight 当前具有标准版和企业版。每个版本中并未提供所有操作和功能。 HTTTP 状态代码：403 ## 另请参阅有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/GetDashboardEmbedUrl) + [适用于 .NET 的 AWS SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/GetDashboardEmbedUrl) + [适用于 C\+\+ 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/GetDashboardEmbedUrl) + [适用于 Go 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/GetDashboardEmbedUrl) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/GetDashboardEmbedUrl) + [AWS适用于的开发工具包 JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/GetDashboardEmbedUrl) + [适用于 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/GetDashboardEmbedUrl) + [适用于 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/GetDashboardEmbedUrl) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/GetDashboardEmbedUrl)