SLS から DQL への変換¶
POST /api/v1/sls/convert
概要¶
Alibaba Cloud SLS のクエリステートメントをログ DQL に変換します。ワークスペース内のデータはクエリしません。
呼び出し前の準備と使用手順¶
- Alibaba Cloud SLS のクエリからクエリ式をコピーします。結果に使用するログインデックスを限定する必要がある場合は、先に現在のワークスペースのログインデックスリストを取得します。
- 変換リクエストを送信します。この API はワークスペース内でクエリを実行しません。
statusとdiagnosticsを確認します。近似変換の場合は差異を手動で確認し、確認後にdqlを DQL クエリ API に渡します。
例えば、query が「* | SHOW TABLES」の場合は unsupported が返されることがあります。この場合は diagnostics に基づいて手動で調整が必要な箇所を判断します。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | AK 識別子、AK uuid 例: <DF-API-KEY>取得または入力方法: 対象のワークスペースの API Key 管理で、この API の権限を持つ Key を作成または取得します。 |
ボディリクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| query | string | Y | Alibaba Cloud SLS クエリステートメント null を許可: False 空文字列を許可: False 例: status:200取得または入力方法: 変換する部分を SLS クエリステートメントからコピーします。JSON 文字列は二重引用符を使用します。 |
| indexes | array | 任意。ログインデックス名のリスト。未指定または空配列の場合はインデックスを制限しません null を許可: False 例: ["default"]取得または入力方法: 既存のログインデックス名の配列を入力します。ログインデックスリストが返す content.data[*].name から取得します。 |
パラメータ補足説明¶
返される status は変換の等価性の度合いを示します。
exact: 生成された DQL は元の SLS クエリと等価です。approximate: 近似 DQL が生成されています。呼び出し元はdiagnosticsを参照して差異を確認したうえで実行してください。unsupported: 現在の SLS 構文には対応していません。dqlは空の場合があります。
Studio はログ名前空間 L を固定で使用します。indexes は任意です。未指定または空配列の場合、インデックス制限は付加されません。
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/sls/convert' \
-H 'Content-Type: application/json' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"query":"status:200","indexes":["default"]}'
レスポンス¶
HTTP 200、application/json。例ではリクエストの status:200 と default インデックス条件を保持しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.status | string | 変換結果。exact は正確な変換、approximate は近似変換、unsupported は非対応です。 |
| content.dql | string | 変換後の DQL。ステータスが unsupported の場合は空または省略されることがあります。 |
| content.diagnostics | array | 変換診断。正確な変換で診断がない場合は []、それ以外の結果は変換器が実際に返した内容です。 |
| content.diagnostics[].severity | string | 診断の重大度。例: warning または error。 |
| content.diagnostics[].code | string | 診断の識別子。 |
| content.diagnostics[].message | string | 診断の説明。 |
| content.diagnostics[].hint | string | 任意の修正ヒント。 |
| content.unsupported_class | string | 任意。変換が非対応の場合の分類。 |
{
"code": 200,
"content": {
"status": "exact",
"dql": "L(\"default\")::*:(*){ (`status` = 200) }",
"diagnostics": []
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストパラメータがフィールド宣言に違反 | メッセージで無効なフィールドまたはルールを示します。 | 対応するパラメータ表に従ってリクエストを修正します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文エラー | リクエスト JSON の形式エラー。content に reason、line、column が含まれます。 | JSON 構文を修正して再試行します。 |
| 406 | ft.DqlParseError | 変換器が利用できない、または parser 呼び出し時に ParserError がスローされた | DQL parser の解析失敗。メッセージに原因が含まれます。 | まず構文を確認し、変換器が利用できない場合はサービス管理者に連絡します。 |
| 406 | ft.ParameterCheckFailed | query の前後の空白を除去した結果が空、または indexes のメンバーが文字列でない | 汎用のパラメータ検証失敗メッセージを返します。 | 空でない SLS ステートメントと文字列のインデックス配列を使用します。 |