ListDashboard - 查询仪表盘_日志服务(SLS)-阿里云帮助中心

查询仪表盘。

接口说明

请求语法中 Host 由 Project 名称和日志服务 Endpoint 构成，您需要在 Host 中指定 Project。
已创建并获取 AccessKey。更多信息，请参见访问密钥。

阿里云账号 AccessKey 拥有所有 API 的访问权限，风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维。RAM 用户需具备操作日志服务资源的权限。具体操作，请参见创建 RAM 用户及授权。

已明确您查询日志所属的 Project 名称、所属地域等。如何查询，请参见管理 Project。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /dashboards

请求参数

名称	类型	必填	描述	示例值
project	string	是	Project 名称。	ali-test-project
offset	integer	否	查询开始行。默认值为 0。	0
size	integer	否	分页查询时，设置的每页行数。最大值为 500。默认值为 500。	10

返回参数

名称	类型	描述	示例值
headers	object
Server	string	服务器名称。	nginx
Content-Type	string	返回的响应体的内容格式。	application/json
Content-Length	string	响应内容长度。	0
Connection	string	是否长连接。取值包括： close：不是长连接，则每个 HTTP 请求都会重新建立 TCP 连接。 keep-alive：长连接，TCP 连接建立后保持连接状态，节省连接所需时间和带宽。	close
Date	string	返回响应的时间。	Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string	服务端产生的标识，该请求的唯一 ID。	5B0A6B60BB6EE39764D458B5
	object	仪表盘。
dashboards	array	仪表盘的名字列表，对应 dashboardName。
	string	仪表盘的名字列表，对应 dashboardName。	dashboard-1609294922657-434834
dashboardItems	array<object>	仪表盘。
	object	仪表盘。
dashboardName	string	仪表盘 ID。同一个 Project 下，仪表盘 ID 唯一，不可重复。支持模糊查询，例如输入 da，会查询出所有以 da 开头的仪表盘。	dashboard-1609294922657-434834
displayName	string	仪表盘显示名称。	data-ingest

示例

正常返回示例

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.	内部服务调用错误。

更多信息，请参见通用错误码。