Simple Log Service における GetIndex で Logstore インデックス構成をクエリ - Simple Log Service - Alibaba Cloud - Simple Log Service

指定された Logstore のインデックス情報を照会します。

操作説明

操作の説明

リクエスト構文の Host は、プロジェクト名と Log Service のエンドポイントで構成されます。Host にプロジェクトを指定する必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

log:GetIndex

get

*LogStore。

acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}

log:TLSVersion

なし

リクエスト構文

GET /logstores/{logstore}/index HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
logstore	string	必須	Logstore 名。	test-logstore

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
project	string	必須	プロジェクト名。	ali-test-project

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンス構造体。
index_mode	string	インデックスタイプ。	v2
keys	object	フィールドインデックスの構成。キーはフィールド名、値はインデックス構成です。
	object	単一フィールドのインデックス構成。
caseSensitive	boolean	大文字と小文字を区別するかどうかを示します。このパラメーターは、type が text に設定されている場合にのみ必須です。有効値： true false
chn	boolean	中国語文字が含まれるかどうかを示します。このパラメーターは、type が text に設定されている場合にのみ必須です。有効値： true false
token	array	デリミタ。
	string	デリミタ。このパラメーターは、type が text に設定されている場合にのみ必須です。
type	string	フィールド値のデータの型。有効値：text、json、double、long。
doc_value	boolean	フィールドの分析機能が有効かどうかを示します。有効値： true false
alias	string	フィールドのエイリアス。
lastModifyTime	integer	インデックスが最後に更新された時間。この値は、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) からの経過秒数を表す UNIX タイムスタンプです。	1524155379
line	object	フルテキストインデックスの構成。
caseSensitive	boolean	大文字と小文字を区別するかどうかを指定します。有効な値: true: 大文字と小文字を区別します。 false: 大文字と小文字を区別しません。	false
chn	boolean	中国語文字を含めるかどうかを指定します。有効な値: true: 中国語文字を含めます。 false: 中国語文字を含めません。	false
exclude_keys	array	除外するフィールドのリスト。
	string	除外するフィールドのリスト。	excludeField
include_keys	array	含めるフィールドのリスト。
	string	含めるフィールドのリスト。	includeField
token	array	トークンのリスト。
	string	トークン。たとえば、","、"."、"\r"、"\n" などです。	,
log_reduce	boolean	LogReduce が有効かどうかを指定します。	false
log_reduce_black_list	array	LogReduce フィールドフィルタリングのブラックリスト。このパラメーターは、LogReduce が有効な場合にのみ有効です。
	string	ブラックリストに登録されたフィールド。	b
log_reduce_white_list	array	LogReduce フィールドフィルタリングのホワイトリスト。このパラメーターは、LogReduce が有効な場合にのみ有効です。
	string	ホワイトリストに登録されたフィールド。	a
max_text_len	integer	Log Service におけるフィールド値のデフォルトの最大長は 2,048 バイト (2 KB) です。フィールド値の最大長を変更するには、統計フィールド (text) の最大長を設定します。有効な値: 64～16,384 バイト。	2048
storage	string	ストレージタイプ。値は pg に固定されています。	pg
ttl	integer	インデックスファイルのライフサイクル。有効な値: 7、30、90。単位: 日。	30

例

成功レスポンス

JSONJSON

{
  "index_mode": "v2",
  "keys": {
    "key": {
      "caseSensitive": false,
      "chn": false,
      "token": [
        ""
      ],
      "type": "",
      "doc_value": false,
      "alias": ""
    }
  },
  "lastModifyTime": 1524155379,
  "line": {
    "caseSensitive": false,
    "chn": false,
    "exclude_keys": [
      "excludeField"
    ],
    "include_keys": [
      "includeField"
    ],
    "token": [
      ","
    ]
  },
  "log_reduce": false,
  "log_reduce_black_list": [
    "b"
  ],
  "log_reduce_white_list": [
    "a"
  ],
  "max_text_len": 2048,
  "storage": "pg",
  "ttl": 30
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。