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 A QuickSight 当前具有标准版和企业版。每个版本中并未提供所有操作和功能。

HTTP 状态代码:403

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: