本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # GetDashboardEmbedUrl 生成臨時會話 URL 和授權碼（承載令牌），您可以用它來嵌入 Amazon QuickSight 網站或應用程式中的唯讀儀表板。使用此命令之前，請確定您已經設定儀表板和權限。目前，您可以使用`GetDashboardEmbedURL`僅從服務器，而不是從用戶的瀏覽器。下列規則會套用至產生的 URL： + 它們必須一起使用。 + 它們只能使用一次。 + 它們在您執行此命令之後的 5 分鐘內有效。 + 只有在使用網址或與亞馬遜互動時才會向您收費 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`因為其他身分類型會以 Amazon 身分驗證 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 讀者) 在檢視儀表板時進行選擇。如果此設定為`TRUE`，當訂閱者重新開啟相同的儀表板 URL 時，設定相同。該狀態存放在 Amazon QuickSight，而不是在瀏覽器 cookie 中。如果設定為 FALSE，則不會保留使用者工作階段的狀態。預設值為 `FALSE`。 ** [UndoRedoDisabled](#API_GetDashboardEmbedUrl_RequestSyntax) ** 移除內嵌儀表板上的復原/重做按鈕。預設值為 FALSE，可啟用「復原/重做」按鈕。 ** [UserArn](#API_GetDashboardEmbedUrl_RequestSyntax) ** Amazon QuickSight 使用者的 Amazon Resource Name (ARN)，可搭配使用`QUICKSIGHT`身分類型。您可以使用任何 Amazon QuickSight 您帳戶中的使用者 (讀者、作者或管理員)，並經過身份驗證為下列其中一項： + Active Directory (AD) 使用者或群組成員 + 受邀的非同盟使用者 + 使用 SAML、OpenID Connect 或 IAM Federation Federation 並透過聯合單一登入進行驗證的 IAM 使用者，和以 IAM 角色為基礎的工作階段。針對第三個群組中的使用者 (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。此 URL 的有效期為 5 分鐘。該 API 操作提供了一個網址`auth_code`此值可讓您一次 (且只有一次) 登入使用者工作階段，該使用者工作階段有效期為 10 小時。類型：字串 ** [RequestId](#API_GetDashboardEmbedUrl_ResponseSyntax) ** 所以此AWS此操作的請求 ID。類型：字串 ## 錯誤如需所有動作常見的錯誤相關資訊，請參閱[常見錯誤](CommonErrors.md)。 ** AccessDeniedException ** 您無法存取此項目。提供的登入資料無法驗證。您可能無法取得授權以執行請求。確保您的帳戶已獲授權使用亞馬遜 QuickSight 服務，您的政策有正確許可，並且您正在使用正確的存取金鑰。 HTTP 狀態碼：401 ** DomainNotWhitelistedException ** 指定的網域不在允許清單中。內嵌儀表板的所有網域都必須由 Amazon 新增至核准的清單 QuickSight admin。 HTTP 狀態碼：403 ** IdentityTypeNotSupportedException ** 不支援指定的身分類型。支援的身分類型包括：`IAM`和`QUICKSIGHT`。 HTTP 狀態碼：403 ** InternalFailureException ** 發生內部故障。 HTTP 狀態碼：500 ** InvalidParameterValueException ** 一或多個參數的值無效。 HTTP 狀態碼：400 ** QuickSightUserNotFoundException ** 找不到提供名稱的使用者。這可能發生於需要根據所提供使用者名稱尋找使用者的任何操作，例如`DeleteUser`、`DescribeUser`，以此類推。 HTTP 狀態碼：404 ** ResourceExistsException ** 指定的資源已存在。 HTTP 狀態碼：409 ** ResourceNotFoundException ** 無法找到一個或多個資源。 HTTP 狀態碼：404 ** SessionLifetimeInMinutesInvalidException ** 針對工作階段生命週期指定的分鐘數無效。工作階段生命週期必須為 15-600 分鐘。 HTTP 狀態碼：400 ** ThrottlingException ** 存取已調節。 HTTP 狀態碼：429 ** UnsupportedPricingPlanException ** 此錯誤表明您正在調用亞馬遜中的嵌入操作 QuickSight沒有所需的定價計劃AWS帳戶。在您可以為匿名使用者使用內嵌之前， QuickSight 管理員需要將容量定價新增至 Amazon 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 Amazon QuickSight 目前包含 Standard Edition (企業版) 和 Enterprise Edi 不是每個版本都會提供所有操作和功能。 HTTP 狀態碼：403 ## 另請參閱如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明： + [AWS 命令列界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/GetDashboardEmbedUrl) + [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/GetDashboardEmbedUrl) + [適用於 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/GetDashboardEmbedUrl) + [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/GetDashboardEmbedUrl) + [適用於 Java 的 AWS 開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/GetDashboardEmbedUrl) + [AWS適用於的 SDK 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 的 AWS 開發套件第 3 版](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/GetDashboardEmbedUrl)