DescribeDashboard

请求语法

POST /DescribeDashboard HTTP/1.1
Authorization: <AuthorizationString>
x-klog-api-version: 0.1.0
Host:klog.api.ksyun.com
x-klog-signature-method: hmac-sha1
Date: <GMT Date>
Content-Type: application/json
Content-MD5: <Content-MD5>
Content-Length: <ContentLength>
Connection: Keep-Alive
{
  "DashboardId": <DashboardId>
}

请求参数

该接口无特有请求头。获取更多信息，请参见公共请求头
参数详情具体如下表。

参数名称	类型	是否必须	描述
DashboardId	String	是	仪表盘ID

响应参数

参数详情具体如下表。

参数名称	类型	描述
CreateTime	String	创建时间
Time	String	最后一次修改时间
Charts	list	图表信息
DashboardName	String	仪表盘名称

*Charts参数如下：

参数名称	类型	描述
ChartName	String	图表名称
ChartId	String	图表ID
Type	String	图表类型，暂规划两个类型，line：曲线图，table：表格
Search	Search	查询结构
Display	Display	展示结构

*Search参数如下：

参数名称	类型	描述
LogPoolName	String	日志池名称
TimeRange	String	查询数据的时间范围
Query	String	查询语句

错误码

除公共错误码外，还可能返回如下特有错误码：

Http状态码	errorCode	errorMessage
400	DashboardNotExist	Dashboard {dashboardId} not exist

示例

请求示例

POST /CreateDashboard HTTP/1.1
Authorization: KLOG <yourAccessKeyId>:<yourSignature>
x-klog-api-version: 0.6.0
Host:klog.api.ksyun.com
x-klog-signature-method: hmac-sha1
Date: Sun, 27 May 2018 07:43:26 GMT
Content-Type: application/json
Content-MD5: A7967D81EFF5E3CD447FB6D8DF294E20
Content-Length: 80
Connection: Keep-Alive
{
  "ProjectName": “my-test-project”,
  "DashboardName" : "my-dashboard",
  "DashboardId": "A7967D81EFF5E3CD447FB6D8DF294E20"
}

响应示例

HTTP/1.1 200
Server: nginx
Content-Length: 0
Connection: close
Access-Control-Allow-Origin: *
Date: Sun, 27 May 2018 07:43:27 GMT
x-klog-requestid: 5B0A619F205DC3F30EDA9322
{
  "createTime": "Sun, 27 May 2018 07:43:26 GMT",
  "lastModifyTime": "Sun, 27 May 2018 07:43:26 GMT"
  "charts":[
    {  
        "ChartName":"my-chart",
        "ChartId": "chart-1502321435-002",
        "Type": "table",
        "Search" : {
            "LogPoolName": "my-logPool",
            "TimeRange"："last 15 minutes",
            "Query": "select count(*) as pv where code=500"
        },
        "Display": {
            ...... 
        }
    }
  ]
}