設定の詳細を取得します。
例:
GET /configs/{configName}
リクエスト構文
GET /configs/<configName> HTTP/1.1
Authorization: <AuthorizationString>
Date: <GMT Date>
Host: <Project Endpoint>
x-log-apiversion: 0.6.0
x-log-signaturemethod: hmac-sha1
リクエストパラメーター
パラメーター名 | データ型 | 必須/省略可能 | 説明 |
---|---|---|---|
ConfigName | String | 必須 | Logtail 設定名 |
GetConfig API には特別なリクエストヘッダーはありません。 Log Service API のパブリックリクエストヘッダーの詳細については、「パブリックリクエストヘッダー」をご参照ください。
レスポンスヘッダーGetConfig API には特別なレスポンスヘッダーはありません。 Log Service API のパブリックレスポンスヘッダーの詳細については、「パブリックレスポンスヘッダー」をご参照ください。
レスポンス要素属性名 | データ型 | 説明 |
---|---|---|
configName | string | 同じプロジェクト内で一意の Logtail 設定名 |
Inputtype | string | 入力タイプ (現時点でファイルのみサポート) |
inputDetail | json | 次の表の説明を参照してください。 |
outputType | string | 出力タイプ 現在、サポートされているのは LogService のみです。 |
outputDetail | json | 次の表の説明を参照してください。 |
createTime | Int | 設定の作成時刻。 |
lastModifyTime | Int | Log Service でリソースが更新された時刻。 |
inputDetail の内容
属性名 | データ型 | 説明 |
---|---|---|
Logtype | String | ログタイプ (現時点で common_reg_log のみをサポート) |
LogPath | string | ログが存在する親ディレクトリ (例:/var/logs/ )
|
filePattern | String | ログ ファイルのパターン。 (例:access*.log )
|
localStorage | boolean | ローカル キャッシュをアクティブにするかどうかを設定します。 Log Service へのリンクが切断されると、1 GB のログをローカルにキャッシュできます。 |
timeFormat | string | ログ時刻の形式 (例:%Y/%m/%d %H:%M:%S )
|
logBeginRegex | string | 最初のログ行の特性 (正規表現) 。複数の行で構成されるログと一致させるために使用します。 |
regex | string | ログの抽出に使用される正規表現。 |
key | array | ログの抽出後に生成されたキー |
filterKey | Array | ログのフィルター処理に使用されるキー。 ログは、対応する filterRegex 列で指定された正規表現とキー値が一致する場合のみ、要件を満たします。 |
filterRegex | array | 各 filterKey に対応する正規表現。 フィルターの長さは、filterKey の長さと同じでなければなりません。 |
topicFormat | string | ログファイルパスの一部をトピックとして使用します (例:/var/log/(. *).log ) デフォルト値は none (トピックが空であることを示します)
|
preserve | boolean | true は、監視対象のディレクトリがタイムアウトしないことを示します。false は、監視対象ディレクトリのタイムアウトが 30 分であることを示します (デフォルトは 0) |
preserveDepth | integer | preserve が false に設定されている場合は、監視タイムアウトなしでディレクトリの深さを指定します。 最大深度は 3 です。 |
fileEncoding | string | utf8 と gbk をサポートするログファイルのエンコード形式。 |
outputDetail の内容
属性名 | データ型 | 必須/省略可能 | 説明 |
---|---|---|---|
endpoint | String | 必須 | プロジェクトが存在するリージョンのアクセス アドレス。 |
logstoreName | string | 必須 | Logstore 名 |
Log Service API の 一般的なエラー コード の他に、GetConfig API から次の特別のエラー コードが返される場合があります。
HTTP ステータスコード | エラーコード | エラーメッセージ |
---|---|---|
404 | ConfigNotExist | Config {configname} が存在しません。 |
500 | InternalServerError | 指定されたサーバーエラーメッセージ |
例
リクエスト例:
GET /configs/logtail-config-sample
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 08:29:15 GMT",
"x-log-apiversion": "0.6.0",
"Authorization": "LOG <yourAccessKeyId>:<yourSignature>"
}
レスポンス例
Header :
{
"content-length": "730",
"server": "nginx/1.6.1",
"connection": "close",
"date": "Mon, 09 Nov 2015 08:29:15 GMT",
"content-type": "application/json",
"x-log-requestid": "5640595B99248CAA23004A59"
}
Body :
{
"configName": "logtail-config-sample",
"outputDetail": {
"endpoint": "http://cn-hangzhou-devcommon-intranet.sls.aliyuncs.com",
"logstoreName": "sls-test-logstore"
},
"outputType": "LogService",
"inputType": "file",
"inputDetail": {
"regex": "([\\d\\.] +) \\S+ \\S+ \\[(\\S+) \\S+\\] \"(\\w+) ([^\"]*)\" ([\\d\\.]+) (\\d+) (\\d+) (\\d+|-) \"([^\"]*)\" \"([^\"]*)\".*",
"filterKey": [],
"logPath": "/var/log/httpd/",
"logBeginRegex": "\\d+\\.\\d+\\.\\d+\\.\\d+ - .*",
"logType": "common_reg_log",
"topicFormat": "none",
"localStorage": true,
"key": [
"ip",
"time",
"method",
"url",
"request_time",
"request_length",
"status",
"length",
"ref_url",
"browser"
],
"filePattern": "access*.log",
"timeFormat": "%d/%b/%Y:%H:%M:%S",
"filterRegex": []
},
"createTime": 1447040456,
"lastModifyTime": 1447050456
}