本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # GenerateEmbedUrlForRegisteredUser 生成可用于嵌入亚马逊的嵌入 URL QuickSight 在您的网站上的体验。此操作可用于在亚马逊注册的任何类型的用户 QuickSight account. 在使用此操作之前，请确保您已配置相关Amazon QuickSight 资源和权限。以下规则适用于生成的 URL： + 它包含一个临时不记名令牌。生成后的 5 分钟内有效。在此期限内兑换后，将无法再次使用。 + 不应将 URL 有效期与实际会话生命周期混淆，后者可以使用` [SessionLifetimeInMinutes](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes) `参数。生成的用户会话有效期为 15 分钟（最短）到 10 小时（最长）。默认会话持续时间为 10 小时。 + 只有在使用 URL 或与亚马逊进行互动时，您才需要付费 QuickSight. 有关更多信息，请参阅。[嵌入式分析](https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html)中的*亚马逊 QuickSight 用户指南*. 有关嵌入的高级步骤的详细信息以及自定义嵌入方式的交互式演示，请访问[亚马逊 QuickSight 开发人员门户](https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html). ## 请求语法 ``` POST /accounts/AwsAccountId/embed-url/registered-user HTTP/1.1 Content-type: application/json { "AllowedDomains": [ "string" ], "ExperienceConfiguration": { "Dashboard": { "InitialDashboardId": "string" }, "QSearchBar": { "InitialTopicId": "string" }, "QuickSightConsole": { "InitialPath": "string" } }, "SessionLifetimeInMinutes": number, "UserArn": "string" } ``` ## URI 请求参数请求使用以下 URI 参数。 ** [AwsAccountId](#API_GenerateEmbedUrlForRegisteredUser_RequestSyntax) ** 用于的IDAWS 账户包含您要嵌入的仪表板。长度约束：固定长度为 12。模式：`^[0-9]{12}$` 必需：是 ## 请求正文请求接受采用 JSON 格式的以下数据。 ** [ExperienceConfiguration](#API_GenerateEmbedUrlForRegisteredUser_RequestSyntax) ** 你正在嵌入的体验。对于注册用户，您可以嵌入亚马逊 QuickSight 整个亚马逊的仪表板 QuickSight 控制台。类型：[RegisteredUserEmbeddingExperienceConfiguration](API_RegisteredUserEmbeddingExperienceConfiguration.md) 对象必需：是 ** [UserArn](#API_GenerateEmbedUrlForRegisteredUser_RequestSyntax) ** 注册用户的 Amazon 资源名称。类型: 字符串必需：是 ** [AllowedDomains](#API_GenerateEmbedUrlForRegisteredUser_RequestSyntax) ** 要添加到允许列表以访问随后嵌入的生成的 URL 的域。此可选参数将覆盖在 Manage 中配置的静态域 QuickSight 亚马逊的菜单 QuickSight 控制台。相反，它只允许您在此参数中包含的域。在每个 API 调用中，您最多可以列出三个域或子域。要将特定域下的所有子域包含到允许列表中，请使用`*`. 例如，`https://*.sapp.amazon.com`包括以下所有子域`https://sapp.amazon.com`. 类型: 字符串数组必需：否 ** [SessionLifetimeInMinutes](#API_GenerateEmbedUrlForRegisteredUser_RequestSyntax) ** 会话的有效时长（以分钟为单位）。会话生命周期必须介于 [15-600] 分钟范围内。类型: 长整型有效范围：最小值为 15。最大值为 600。必需：否 ## 响应语法 ``` HTTP/1.1 Status Content-type: application/json { "EmbedUrl": "string", "RequestId": "string" } ``` ## 响应元素如果此操作成功，则该服务将会发送回 HTTP 响应。 ** [Status](#API_GenerateEmbedUrlForRegisteredUser_ResponseSyntax) ** 请求的 HTTP 状态。服务以 JSON 格式返回的以下数据。 ** [EmbedUrl](#API_GenerateEmbedUrlForRegisteredUser_ResponseSyntax) ** 亚马逊的嵌入 URL QuickSight 仪表板或控制台。类型: 字符串 ** [RequestId](#API_GenerateEmbedUrlForRegisteredUser_ResponseSyntax) ** 这些区域有：AWS用于此操作的请求 ID。类型: 字符串 ## 错误有关所有操作共有的错误的信息，请参阅[常见错误](CommonErrors.md). ** AccessDeniedException ** 您无权访问此项目。无法验证提供的凭证。您可能无权执行请求。确保您的账户已获得使用亚马逊的授权 QuickSight 服务，您的策略具有正确的权限，并且您使用的是正确的访问密钥。 HTTP 状态代码：401 ** InternalFailureException ** 出现内部故障。 HTTP 状态代码：500 ** InvalidParameterValueException ** 一个或多个参数的值无效。 HTTP 状态代码：400 ** QuickSightUserNotFoundException ** 未找到具有所提供名称的用户。这可能发生在需要基于提供的用户名查找用户的任何操作中，如`DeleteUser`、`DescribeUser`、、、、、、、、、等等。 HTTP 状态代码：404 ** ResourceNotFoundException ** 无法找到一个或多个资源。 HTTP 状态代码：404 ** SessionLifetimeInMinutesInvalidException ** 为会话生命周期指定的分钟数无效。会话生命周期必须为 15-600 分钟。 HTTP 状态代码：400 ** ThrottlingException ** 访问受限。 HTTP 状态代码：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`选项。 HTTP 状态代码：403 ** UnsupportedUserEditionException ** 此错误指示您正在 Amazon 上调用某个操作 QuickSight该版本不支持该操作的订阅。Amazon QuickSight 当前具有标准版和企业版。每个版本中并未提供所有操作和功能。 HTTP 状态代码：403 ## 另请参阅有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容： + [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) + [适用于 .NET 的 AWS SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) + [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) + [适用于 Go 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) + [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) + [AWS适用于的开发工具包 JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) + [适用于 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) + [适用于 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser) + [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/GenerateEmbedUrlForRegisteredUser)