金山云-文档中心-ListDashboards

请求语法

POST /ListDashboards 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
{
  "ProjectName": <ProjectName>,
  "Page" : <Page>,
  "Size" : <size>
}

请求参数

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

参数名称	类型	是否必须	描述
ProjectName	String	是	工程名称
Page	Int	否	返回的分页数，从0开始
Size	Int	否	每页返回最大条目，默认 500（最大值）

响应参数

参数名称	类型	描述
Total	Int	仪表盘总数
Dashboards	list	每页返回最大条目，默认 500（最大值）
Count	Int	返回的仪表盘数量
ProjectName	String	工程名称

Dashboard参数说明如下：

参数名称	类型	描述
DashboardName	String	仪表盘名称
DashboardId	String	仪表盘ID
CreateTime	Date	创建时间

示例

请求示例

POST /ListDashboards 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”
}

响应示例

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
{
  "ProjectName" : "my-test-project",
  "Count" : 5,
  "Total" : 50,
  "Dashboards": [
    {
        "DashboardName": "my-dashboard",
        "DashboardId": "dashboard-12535235-001",
        "CreateTime":"2020-02-02 15:30：00"
    }
  ]
}