コンテンツにスキップ

SLS を DQL に変換¶

POST /api/v1/sls/convert

概要¶

Alibaba Cloud SLS のクエリ文をログ DQL に変換します。この API は構文変換のみを行い、ワークスペースのデータをクエリまたは変更することはありません。

パラメーター名	型	必須	説明
`DF-API-KEY`	string	はい	API Key 識別子。

Body リクエストパラメーター¶

パラメーター名	型	必須	説明
`query`	string	はい	変換対象の Alibaba Cloud SLS クエリ文。空の値は許可されません。
`indexes`	array	いいえ	ログインデックス名のリスト。省略または空配列を指定した場合、生成される DQL にインデックス制限は付与されません。

レスポンスの説明¶

変換結果はレスポンスの content に格納されます：

フィールド	型	説明
`status`	string	変換ステータス。`exact`、`approximate`、`unsupported` のいずれかです。
`dql`	string	変換によって生成されたログ DQL。現在の構文がサポートされていない場合は空になることがあります。
`diagnostics`	array	変換に関する診断情報。近似変換またはサポートされていない構文について説明します。`exact` で診断情報がない場合は空配列を返します。

ステータスの意味：

exact：生成された DQL は元の SLS クエリ文と等価です。
approximate：近似 DQL が生成されました。実行前に diagnostics を確認し、意味の違いを確認してください。
unsupported：現在の SLS 構文はサポートされていません。dql は空になる可能性があります。

変換結果は常にログ名前空間 L を使用します。indexes は DQL テキストの生成にのみ使用され、API はインデックスの存在を検証しません。変換結果を後で実行する際には、対応するデータクエリ API によって権限とデータアクセスルールの検証が行われます。

リクエスト例¶

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"]}'

レスポンス例¶

{
  "code": 200,
  "content": {
    "status": "exact",
    "dql": "L::re(`.*`):(*)",
    "diagnostics": []
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-XXXX"
}