DescribeDashboard - Amazon QuickSight

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

DescribeDashboard

提供儀表板的摘要。

請求語法

GET /accounts/AwsAccountId/dashboards/DashboardId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1

URI 請求參數

請求會使用下列 URI 參數。

AliasName

別名名稱。

長度限制:長度下限為 1。長度上限為 2048。

模式:[\w\-]+|(\$LATEST)|(\$PUBLISHED)

AwsAccountId

的 IDAWS包含您所描述之儀表板的帳戶。

長度限制:12 的固定長度。

模式:^[0-9]{12}$

必要:是

DashboardId

儀表板的 ID。

長度限制:長度下限為 1。長度上限為 2048。

模式:[\w\-]+

必要:是

VersionNumber

儀表板的版本號碼。如果未傳遞版本號碼,則會說明最新發佈的儀表板版本。

有效範圍:最小值為 1。

請求主體

請求沒有請求主體。

回應語法

HTTP/1.1 Status Content-type: application/json { "Dashboard": { "Arn": "string", "CreatedTime": number, "DashboardId": "string", "LastPublishedTime": number, "LastUpdatedTime": number, "Name": "string", "Version": { "Arn": "string", "CreatedTime": number, "DataSetArns": [ "string" ], "Description": "string", "Errors": [ { "Message": "string", "Type": "string" } ], "Sheets": [ { "Name": "string", "SheetId": "string" } ], "SourceEntityArn": "string", "Status": "string", "ThemeArn": "string", "VersionNumber": number } }, "RequestId": "string" }

回應元素

如果動作成功,則服務傳回下列 HTTP 回應。

Status

請求的 HTTP 狀態。

服務會傳回下列 JSON 格式的資料。

Dashboard

有關儀表板的資訊。

類型:Dashboard 物件

RequestId

所以此AWS此操作的請求 ID。

類型:字串

錯誤

如需所有動作常見的錯誤相關資訊,請參閱常見錯誤

AccessDeniedException

您無法存取此項目。提供的登入資料無法驗證。您可能無法取得授權以執行請求。確保您的帳戶已獲授權使用亞馬遜 QuickSight 服務,您的政策有正確許可,以及您使用正確的存取金鑰。

HTTP 狀態碼:401

InternalFailureException

發生內部故障。

HTTP 狀態碼:500

InvalidParameterValueException

一或多個參數的值無效。

HTTP 狀態碼:400

ResourceNotFoundException

無法找到一個或多個資源。

HTTP 狀態碼:404

ThrottlingException

存取已調節。

HTTP 狀態碼:429

UnsupportedUserEditionException

此錯誤表示您正在呼叫 Amazon 上的操作 QuickSight訂閱版本不包括對該操作的支持。Amazon Amazon QuickSight 目前包含 Standard Edition (企業版)。不是每個版本都會提供所有操作和功能。

HTTP 狀態碼:403

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: