プロジェクト内のすべての設定を一覧表示します。 このパラメータを使用してページを反転できます。
例:
GET /configs? offset=1&size=100
リクエスト構文
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
リクエストパラメーター
URL パラメータ
名前 | データ型 | 必須/省略可能 | 説明 |
---|---|---|---|
offset(optional) | integer | 省略可能 | 返されるレコードの開始位置 (デフォルトは 0)。 |
size(optional) | integer | 省略可能 | 各ページに返されるエントリの最大数。 デフォルト値は 500 (最大値) です。 |
ListConfig API には特別なリクエストヘッダーはありません。Log Service API のパブリックリクエストヘッダーの詳細については、「パブリックリクエストヘッダー」をご参照ください。
レスポンスヘッダーListConfig API には特別なレスポンスヘッダーはありません。Log Service API のパブリックレスポンスヘッダーの詳細については、「パブリックレスポンスヘッダー」をご参照ください。
レスポンス要素レスポンス本文には、特定のプロジェクト内のすべての設定の一覧が含まれます。 以下は具体的な形式です。
エラーコード名前 | データ型 | 説明 |
---|---|---|
count | integer | 返される設定の数 |
total | integer | Log Service の設定の合計数。 |
integer | string array | 返される設定名の一覧 |
Log Service API の 一般的なエラー コード の他に、 ListConfig API から次の特別のエラー コードが返される場合があります。
HTTP ステータスコード | エラーコード | エラーメッセージ |
---|---|---|
404 | ConfigNotExist | config {Configname} が存在しません。 |
500 | InternalServerError | 内部サーバーエラー |
例
リクエスト例
GET /configs? offset=0&size=3 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": "Tue, 10 Nov 2015 19:13:28 GMT",
"x-log-apiversion": "0.6.0",
"Authorization": "LOG <yourAccessKeyId>:<yourSignature>"
}
レスポンス例Header :
{
"content-length": "41",
"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": 8
}