alibabacloud-sls-cli-guidance

Aliyun SLS CLI

プロジェクト、ログストア、Logtail 設定、マシングループ、その他のクエリ以外の操作など、Alibaba Cloud Simple Log Service（SLS）のリソースを管理するコマンドラインインターフェースです。

前提条件

開始する前に、aliyun-cli と sls プラグインがインストールされていることを確認してください。

aliyun version
aliyun sls version

想定される出力：aliyun-cli-sls 0.1.0 (5e6288421) または同様の内容

インストール（未インストールの場合）

確認に失敗した場合は、references/cli-installation-guide.md に従って aliyun-cli をインストールしてから、sls プラグインをインストールしてください。

aliyun plugin install --names sls

プラグインの更新

aliyun plugin update sls

Alibaba Cloud の認証情報が設定されていることを確認する

aliyun configure list を実行して、認証情報が設定されているか確認してください。 有効なプロファイルが表示されない場合は、ここで停止し、ユーザーにこのセッション外で aliyun configure を実行するよう依頼してください。

セキュリティルール：

• AK/SK の値を読み取ったり、エコーしたり、表示したりすることは絶対にしないでください
• 会話内に AK/SK を貼り付けるようユーザーに求めることは絶対にしないでください
• 認証情報の状態の確認には aliyun configure list のみを使用してください

オブザーバビリティ

このスキルが読み込まれたら、セッションごとにランダムなセッション ID を 1 つ生成してください。これは小文字の 16 進数 32 文字の文字列です。

クラウド API を呼び出すすべての aliyun コマンドには、次の User-Agent フラグを含める必要があります。

--user-agent "AlibabaCloud-Agent-Skills/alibabacloud-sls-cli-guidance/{session-id}"

ローカルのユーティリティコマンドはクラウド API を呼び出さないため、aliyun version、aliyun configure ...、aliyun plugin ...、aliyun help ... などでは --user-agent を含めないでください。

例：

aliyun sls list-project \
  --offset 0 --size 50 \
  --user-agent "AlibabaCloud-Agent-Skills/alibabacloud-sls-cli-guidance/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"

ログのクエリと分析

すべてのログのクエリと分析のタスクには、alibabacloud-sls-query スキルを使用してください。このスキルでは、SLS のクエリと分析の構文（インデックス検索、SQL、SPL）、シナリオ例、トラブルシューティング、エンドツーエンドのクエリワークフローを扱います。SLS ログをクエリする際に必須のスキルです。

次の依頼があった場合は、alibabacloud-sls-query を使用してください。

• ログのクエリ、分析、またはクエリ結果のトラブルシューティング
• SLS のインデックス検索、SQL、SQL スキャン、または SPL の作成、説明、最適化、実行
• 自然言語を SLS クエリ、SQL、または SPL ステートメントに変換
• get-logs-v2、クエリ構文、インデックスや統計情報の前提条件のデバッグ

このスキルを利用できる場合は、そのまま使用してください。利用できない場合は、alibabacloud-sls-query-installation を参照してインストールし、読み込んでください。

一般的な操作

プロジェクト、ログストア、インデックスの管理、Logtail 設定、マシングループ、put-logs、その他のクエリ以外の SLS 操作については、このスキルを使用し、以下のリファレンスドキュメントを参照してください。実行する前に、対応するリファレンスファイルを必ず読んでください。

リファレンス	関連コマンド	説明
project	list-project create-project get-project update-project delete-project	SLS プロジェクトを管理します
logstore	list-log-stores create-log-store get-log-store update-log-store delete-log-store	プロジェクト内のログストアを管理します
index	get-index create-index update-index delete-index	クエリと SQL 分析を有効にするインデックスを設定します
put-json-logs	put-json-logs	ログストアにログを書き込みます
logtail-config	create-logtail-pipeline-config update-logtail-pipeline-config get-logtail-pipeline-config list-logtail-pipeline-config delete-logtail-pipeline-config	ログ収集用の Logtail パイプライン設定を管理します（ファイル入力、JSON／区切り文字／正規表現による解析、複数行、時刻抽出）
machine-group	create-machine-group update-machine-group get-machine-group list-machine-group delete-machine-group apply-config-to-machine-group remove-config-from-machine-group get-applied-configs	マシングループを管理し、Logtail 設定を適用します

CLI の使用方法

API を確認する

aliyun help sls
aliyun help sls <apiName>

コマンド構文を検証する（ドライラン）

--cli-dry-run を追加すると、実行せずにパラメーターを検証できます。

aliyun sls list-project --offset 0 --size 50 --cli-dry-run

出力形式

すべてのコマンドはデフォルトで JSON を返します。JMESPath 式で出力を絞り込むには、--cli-query を使用します。

aliyun sls list-project --cli-query "projects[*].name"

グローバルパラメーター

• --cli-dry-run：コマンドを実行せずに検証します
• --cli-query <jmespath>：JMESPath で出力を絞り込みます
• --region <region>：リージョンを上書きします
• --help：コマンドのヘルプを表示します

トラブルシューティング

コマンドが失敗した場合や予期しない結果を返した場合は、チェックリストの全文が記載されているreferences/troubleshooting.mdを確認してください。チェックリストには以下が含まれます。

• CLI とプラグインのバージョンに関する問題
• 認証情報とリージョンの設定
• よくあるエラー（ProjectNotExist、Unauthorized、InvalidParameter など）
• リージョンをまたいだプロジェクトの検索（ProjectNotExist の場合）

ルール

1. 非推奨の API は使用しないでください — 動作がサポートされ、予測可能な状態に保たれるよう、現在の代替 API を使用してください。

   非推奨	代わりに使用
   get-logs	get-logs-v2

2. 削除を行う前に、必ずユーザーの明示的な承認を得てください — 削除操作は取り消せません。

3. 破壊的な操作（削除、更新）の前には、まず --cli-dry-run を使用してください。

4. 更新 API にはすべてのパラメーターが必要です — まず対応する Get API を呼び出して現在のパラメーターを取得し、変更しないものも含め、意味のあるパラメーターをすべて更新呼び出しに含めてください。パラメーターを省略すると、デフォルト値にリセットされる場合があります。

5. コマンドが失敗した場合：references/troubleshooting.mdに従ってください。

6. ログのクエリと分析には alibabacloud-sls-query スキルを使用してください。