文档

ListDashboard - 查询仪表盘

更新时间:

查询仪表盘。

接口说明

  • 请求语法中 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:ListDashboardList
  • Project
    acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/dashboard/*
  • log:TLSVersion

请求语法

GET /dashboards

请求参数

名称类型必填描述示例值
projectstring

Project 名称。

ali-test-project
offsetinteger

查询开始行。默认值为 0。

0
sizeinteger

分页查询时,设置的每页行数。最大值为 500。默认值为 500。

10

返回参数

名称类型描述示例值
headersobject
Serverstring

服务器名称。

nginx
Content-Typestring

返回的响应体的内容格式。

application/json
Content-Lengthstring

响应内容长度。

0
Connectionstring

是否长连接。取值包括:

  • close:不是长连接,则每个 HTTP 请求都会重新建立 TCP 连接。
  • keep-alive:长连接,TCP 连接建立后保持连接状态,节省连接所需时间和带宽。
close
Datestring

返回响应的时间。

Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring

服务端产生的标识,该请求的唯一 ID。

5B0A6B60BB6EE39764D458B5
object

仪表盘。

dashboardsarray

仪表盘的名字列表,对应 dashboardName。

string

仪表盘的名字列表,对应 dashboardName。

dashboard-1609294922657-434834
dashboardItemsobject []

仪表盘。

dashboardNamestring

仪表盘 ID。同一个 Project 下,仪表盘 ID 唯一,不可重复。支持模糊查询,例如输入 da,会查询出所有以 da 开头的仪表盘。

dashboard-1609294922657-434834
displayNamestring

仪表盘显示名称。

data-ingest

示例

正常返回示例

JSON格式

{
  "dashboards": [
    "dashboard-1609294922657-434834"
  ],
  "dashboardItems": [
    {
      "dashboardName": "dashboard-1609294922657-434834",
      "displayName": "data-ingest"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

HttpStatusCodeErrorCodeErrorMessage错误码描述
404ProjectNotExistProject does not exist.Project 不存在。
400ParameterInvalidoffset: offset is invalid.offset 参数取值无效。
400ParameterInvalidsize: size is invalid.size 参数取值无效。
500InternalServerErrorSpecified Server Error Message.内部服务调用错误。

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

  • 本页导读 (1)