查询仪表盘。
接口说明
- 请求语法中 Host 由 Project 名称和日志服务 Endpoint 构成，您需要在 Host 中指定 Project。
- 已创建并获取 AccessKey。更多信息，请参见访问密钥。
阿里云账号 AccessKey 拥有所有 API 的访问权限，风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维。RAM 用户需具备操作日志服务资源的权限。具体操作，请参见创建 RAM 用户及授权。
- 已明确您查询日志所属的 Project 名称、所属地域等。如何查询，请参见管理 Project。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| log:ListDashboard | list |
|
| 无 |
请求语法
GET /dashboards HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| project | string | 是 | Project 名称。 | ali-test-project |
| offset | integer | 否 | 查询开始行。默认值为 0。 | 0 |
| size | integer | 否 | 分页查询时，设置的每页行数。最大值为 500。默认值为 500。 | 10 |
返回参数
示例
正常返回示例
JSON格式
{
"dashboards": [
"dashboard-1609294922657-434834"
],
"dashboardItems": [
{
"dashboardName": "dashboard-1609294922657-434834",
"displayName": "data-ingest"
}
]
}错误码
访问错误中心查看更多错误码。
| HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |
|---|---|---|---|
| 404 | ProjectNotExist | Project does not exist. | Project 不存在。 |
| 400 | ParameterInvalid | offset: offset is invalid. | offset 参数取值无效。 |
| 400 | ParameterInvalid | size: size is invalid. | size 参数取值无效。 |
| 500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |
更多信息，请参见通用错误码。