GetDashboard - 获取指定仪表盘

获取指定仪表盘。

接口说明

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

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

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

调试

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

授权信息

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

请求语法

GET /dashboards/{dashboardName} HTTP/1.1

请求参数

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

Project 名称。

ali-test-project
dashboardNamestring

仪表盘名称。

dashboard-1609294922657-434834

返回参数

名称类型描述示例值
headersobject
Serverstring

服务器名称。

nginx
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
dashboard

仪表盘数据结构。

示例

正常返回示例

JSON格式

{
  "dashboardName": "dashboard-1609294922657-434834",
  "displayName": "test-alert",
  "description": "这是一个仪表盘。",
  "attribute": {
    "key": "yyy"
  },
  "charts": [
    {
      "title": "my-chart",
      "type": "linepro",
      "search": {
        "test": "test",
        "test2": 1
      },
      "display": {
        "test": "test",
        "test2": 1
      },
      "action": {
        "test": "test",
        "test2": 1
      }
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史