调用ListConfig接口查询指定Project下所有的Logtail采集配置。

请求语法

GET /configs?offset=0&size=100 HTTP/1.1
Authorization: <AuthorizationString> 
Date: <GMT Date>
Host: <Project Endpoint>
x-log-apiversion: 0.6.0
x-log-signaturemethod: hmac-sha1

请求参数

  • 请求头

    ListConfig接口无特有请求头。关于Log Service API的公共请求头,请参见公共请求头

  • 参数列表
    参数名称 数据类型 是否必填 示例值 描述
    offset Integer 0 查询开始行。默认值为0。
    size Integer 10 分页查询时,设置的每页行数。最大值为500。

返回数据

  • 响应头

    ListConfig接口无特有响应头。关于Log Service API的公共响应头,请参见公共响应头

  • 响应元素
    返回HTTP状态码200,表示请求成功。ListConfig接口的响应Body中包括Logtail采集配置信息,如下所示:
    参数名称 数据类型 示例值 描述
    count Integer 3 当前页返回的Logtail采集配置数。
    total Integer 3 符合查询条件的Logtail采集配置总数。
    configs Array [ "logtail-config-sample", "logtail-config-sample-2", "logtail-config-sample-3" ] 当前页返回的Logtail采集配置列表。

示例

  • 请求示例
    GET /configs?offset=0&size=10 HTTP/1.1
    Header :
    {
        "Content-Length": 0, 
        "x-log-signaturemethod": "hmac-sha1", 
        "x-log-bodyrawsize": 0, 
        "User-Agent": "log-python-sdk-v-0.6.0", 
        "Host": "ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com", 
        "Date": "Mon, 09 Nov 2015 09:19:13 GMT", 
        "x-log-apiversion": "0.6.0", 
        "Authorization": "LOG <yourAccessKeyId>:<yourSignature>"
    }
  • 正常返回示例
    Header :
    {
        "content-length": "103", 
        "server": "nginx/1.6.1", 
        "connection": "close", 
        "date": "Mon, 09 Nov 2015 09:19:13 GMT", 
        "content-type": "application/json", 
        "x-log-requestid": "5640651199248CAA2300C2BA"
    }
    Body:
    {
        "count": 3, 
        "configs": 
        [
            "logtail-config-sample", 
            "logtail-config-sample-2", 
            "logtail-config-sample-3"
        ], 
        "total": 3
    }

错误码

HTTP状态码 错误码 错误信息 描述
404 ConfigNotExist config {Configname} does not exist. Logtail采集配置不存在。
500 InternalServerError internal server error. 内部服务调用错误。

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