指定した Logstore のインデックスを照会します。
例:
GET /logstores/{logstoreName}/index
リクエスト構文
GET /logstores/<logstoreName>/index HTTP/1.1
Authorization: <AuthorizationString>
x-log-bodyrawsize: 0
User-Agent: <UserAgent>
x-log-apiversion: 0.6.0
Host: <Project Endpoint>
x-log-signaturemethod: hmac-sha1
Date: <GMT Date>
Content-Type: application/x-protobuf
Connection: Keep-Alive
リクエストパラメーター
属性名 | データ型 | 説明 | 説明 |
---|---|---|---|
logstoreName | string | 必須 | Logstore 名 |
GetIndex インターフェイスに特別のリクエストヘッダーはありません。 Log Service API のパブリックリクエストヘッダーの詳細については、「パブリックリクエストヘッダー」をご参照ください。
レスポンスヘッダーGetIndex インターフェースに特別のレスポンスヘッダーはありません。 Log Service API の パブリックレスポンスヘッダーの詳細については、「パブリックレスポンスヘッダー」をご参照ください。
レスポンス要素GetIndex リクエストが正常に送信されると、 レスポンスボディの指定したプロジェクトと Logstore の中にすべてのコンシューマーグループが以下の形式で含まれます。
属性名 | データ型 | 説明 |
---|---|---|
index_mode | string | インデックスタイプ |
keys | dict | キー値のインデックス設定。 キーはフィールド名を、値はインデックス設定を表します。 |
行 | object | フルテキストインデックス設定 |
storage | string | 格納タイプ。現在は pg。 |
ttl | integer | インデックスファイルライフサイクル。 ライフサイクルは 7 日、30 日、90 日です。 |
lastModifyTime | integer | Unix タイムスタンプ形式でのインデックスの最終更新時間 |
以下の属性を含むフルテキストインデックス設定
属性名 | データ型 | 説明 |
---|---|---|
caseSensitive | bool | 大文字小文字の区別 |
chn | bool | 中国語を含むかどうか |
token | array | 単語区切りリスト |
include_keys | array | 含まれるフィールドのリスト |
exclude_keys | array | 含まれないフィールドのリスト |
キー値インデックスの各フィールドごとに、設定には以下の属性が含まれます。
属性名 | データ型 | 説明 |
---|---|---|
データ型 | string | フィールドタイプ |
alias | string | フィールドエイリアス |
chn | bool | 中国語を含むかどうか このフィールドは、データ型の値がテキストの場合のみ使用可能です。 |
token | array | 単語分割リスト。 このフィールドは、データ型の値がテキストの場合のみ使用可能です。 |
caseSensitive | bool | 大文字小文字の区分。 このフィールドは、データ型の値がテキストの場合のみ使用可能です。 |
doc_value | bool | フィールドの統計分析を有効/無効にします。 |
Log Service API の 一般的なエラー コード に加えて、インターフェースから以下のエラーコードが返される場合があります。
HTTP ステータスコード | エラーコード | エラーメッセージ |
---|---|---|
400 | IndexConfigNotExist | index config doesn’t exist |
404 | ProjectNotExist | The Project does not exist : {Project} |
404 | LogStoreNotExist | logstore {logstoreName} dose not exist |
500 | InternalServerError | Specified Server Error Message |
例
リクエスト例GET /logstores/logstore-4/index HTTP/1.1
Authorization: LOG <yourAccessKeyId>:<yourSignature>
x-log-bodyrawsize: 0
User-Agent: sls-java-sdk-v-0.6.1
x-log-apiversion: 0.6.0
Host: my-project.cn-shanghai.log.aliyuncs.com
x-log-signaturemethod: hmac-sha1
Date: Sun, 06 May 2018 13:08:42 GMT
Content-Type: application/x-protobuf
Connection: Keep-Alive
レスポンス例
HTTP/1.1 200
Server: nginx/1.12.1
Content-Type: application/json
Content-Length: 712
Connection: close
Access-Control-Allow-Origin: *
Date: Sun, 27 May 2018 07:43:27 GMT
x-log-requestid: 5AEEFE5A8B8AEB5E6C82B395
{
"index_mode": "v2",
"keys": {
"agent": {
"alias": "",
"caseSensitive": false,
"chn": false,
"doc_value": true,
"token": [
",",
" ",
"'",
"\"",
";",
"=",
"(",
")",
"[",
"]",
"{",
"}",
"?",
"@",
"&",
"<",
">",
"/",
":",
"\n",
"\t",
"\r"
],
"type": "text"
},
"bytes": {
"alias": "",
"doc_value": true,
"type": "long"
},
"remote_ip": {
"alias": "",
"caseSensitive": false,
"chn": false,
"doc_value": true,
"token": [
",",
" ",
"'",
"\"",
";",
"=",
"(",
")",
"[",
"]",
"{",
"}",
"?",
"@",
"&",
"<",
">",
"/",
":",
"\n",
"\t",
"\r"
],
"type": "text"
},
"response": {
"alias": "",
"doc_value": true,
"type": "long"
}
},
"line": {
"caseSensitive": false,
"chn": false,
"token": [
",",
" ",
"'",
"\"",
";",
"=",
"(",
")",
"[",
"]",
"{",
"}",
"?",
"@",
"&",
"<",
">",
"/",
":",
"\n",
"\t",
"\r"
]
},
"storage": "pg",
"ttl": 30,
"lastModifyTime": 1524155379
}