调用ListProject接口列出符合条件的Project信息。

接口说明

请求语法中Host由Project名称和日志服务Endpoint构成,您需要在Host中指定Project。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

GET / HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
projectName String Query ali-test-project

Project名称。

offset Integer Query 0

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

size Integer Query 10

分页查询时,设置的每页行数。默认值为100,最多返回500个Project信息。

返回数据

名称 类型 示例值 描述
Server String nginx

服务器名称。

Content-Length String 0

响应内容长度。

Connection String close

是否长链接。取值包括:

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

指定允许的跨域请求来源。如果设置为指定来源(例如https://help.aliyun.com/),则仅允许该请求访问。如果设置为*,表示允许所有来源的跨域请求。

Date String Sun, 27 May 2018 08:25:04 GMT

返回响应的时间。

x-log-requestid String 5B0A6B60BB6EE39764D458B5

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

count Long 2

当前页返回的Project个数。

total Long 11

符合查询条件的Project总数。

projects Array of project

符合查询条件Project列表。

示例

请求示例

GET /?projectName=ali-test-project&offset=0&size=10 HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListProjectResponse>
    <count>2</count>
    <total>11</total>
    <projects/>
</ListProjectResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "count" : 2,
  "total" : 11,
  "projects" : [ {
    "projectName" : "regular-nginx",
    "status" : "Normal",
    "owner" : "",
    "description" : "",
    "region" : "cn-hangzhou",
    "createTime" : "1656666120",
    "lastModifyTime" : "1656666120"
  }, {
    "projectName" : "k8s-log-c0a43da7f21a7444bb0d710f6f6b2bb5c",
    "status" : "Normal",
    "owner" : "",
    "description" : "k8s log project, created by alibaba cloud log controller",
    "region" : "cn-hangzhou",
    "createTime" : "1656496084",
    "lastModifyTime" : "1656496084"
  } ]
}

错误码

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

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

404

ParameterInvalid

offset : offset pair is invalid

offset参数取值不合法。

500

InternalServerError

Specified Server Error Message.

内部服务调用错误。

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