调用ListDashboard查询指定Project下所有的仪表盘。
接口说明
- 请求语法中Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。
-
已创建并获取AccessKey。更多信息,请参见访问密钥。
阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维。RAM用户需具备操作日志服务资源的权限。具体操作,请参见创建RAM用户及授权。
- 已明确您查询日志所属的Project名称、所属地域等。如何查询,请参见管理Project。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /dashboards HTTP/1.1
请求参数
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
project | String | Host | 是 | ali-test-project | Project名称。 |
offset | Integer | Query | 否 | 0 | 查询开始行。默认值为0。 |
size | Integer | Query | 否 | 10 | 分页查询时,设置的每页行数。最大值为500。默认值为500。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
Server | String | nginx | 服务器名称。 |
Content-Type | String | application/json | 返回的响应体的内容格式。 |
Content-Length | String | 0 | 响应内容长度。 |
Connection | String | close | 是否长连接。取值包括:
|
Date | String | Sun, 27 May 2018 08:25:04 GMT | 返回响应的时间。 |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 | 服务端产生的标识,该请求的唯一ID。 |
dashboards | Array of String | dashboard-1609294922657-434834 | 仪表盘的名字列表,对应dashboardName。 |
dashboardItems | Array | 仪表盘。 |
|
dashboardName | String | dashboard-1609294922657-434834 | 仪表盘ID。同一个Project下,仪表盘ID唯一,不可重复。支持模糊查询,例如输入da,会查询出所有以da开头的仪表盘。 |
displayName | String | data-ingest | 仪表盘显示名称。 |
示例
请求示例
GET /dashboards?offset=0&size=10 HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/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. |
内部服务调用错误。 |
更多信息,请参见通用错误码。
- 本页导读 (1)