ListConfig接口用于列出Project下所有的配置信息,支持通过参数进行翻页显示 。

请求语法

ListConfig接口的请求语法如下所示。
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的公共请求头,请参见公共请求头

  • URL参数
    参数名称 类型 是否必须 描述
    offset(optional) integer 返回记录的起始位置,默认为0。
    size(optional) integer 每页返回最大条目,默认为最大值500。

响应参数

  • 响应头

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

  • 响应元素
    ListConfig接口的响应Body会包含该project下所有的config列表,具体格式如下。
    名称 类型 描述
    count 整型 返回的config数目。
    total 整型 在服务端config总数。
    configs 字符串数组 返回的config名称列表。

错误码

除了返回Log Service API的通用错误码,还可能返回如下特有错误码。
HTTP 状态码 ErrorCode ErrorMessage
404 ConfigNotExist config {Configname} does not exist
500 InternalServerError internal server error

示例

  • 请求示例
    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
    }