mcpField
A
alibabacloud-rds-copilot

alibabacloud-rds-copilot

github.com/aliyunクラウド・DevOps281438 回インストール1 日前に更新
リポジトリ

alibabacloud-rds-copilot について

Alibaba Cloud RDS Copilotを対話形式で利用するエージェントスキルです。RDSの質問、SQL最適化、トラブルシューティング向けで、Alibaba Cloud CLIからRdsAi OpenAPIを呼び出し、事前にCLI、プラグイン、認証情報を確認します。

主な機能

  1. 01自然言語でRDSタスクを判別
  2. 02RDS Copilotの対話APIを呼び出し
  3. 03結果の説明とエラー診断
  4. 04CLI・プラグイン・認証情報の事前確認

活用シーン

  1. 01SQLの最適化や診断
  2. 02RDSインスタンスの問題調査
  3. 03性能やインスタンスパラメーターの分析
  4. 04RDS関連の質問

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/aliyun/alibabacloud-aiops-skills --skill alibabacloud-rds-copilot

インストール後、Claude Code で/alibabacloud-rds-copilotを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
acceptance-criteria.md
ram-policies.md
related-apis.md
verification-method.md

詳細

Alibaba Cloud RDS Copilot インテリジェント運用アシスタント

このスキルは、会話における Alibaba Cloud RDS Copilot のインテリジェントエージェントとして機能し、RDS 関連のインテリジェントな質疑応答、SQL の最適化、インスタンスの運用、トラブルシューティングをユーザーに支援します。

シナリオの説明

アーキテクチャ:Alibaba Cloud CLI + RdsAi OpenAPI

主な機能:

  • ユーザーの自然言語によるリクエスト(中国語または英語)を理解し、RDS Copilot に関連するものかどうかを判別します
  • Alibaba Cloud CLI を直接呼び出して、aliyun rdsai chat-messages コマンドを実行し、RDS Copilot にリアルタイムで問い合わせます
  • 結果やユーザーが貼り付けたエラーメッセージを受け取った際に、さらに説明、診断を行い、推奨事項を提示します

エージェント実行の契約

RDS Copilot を呼び出す前に、コマンドを実行できる場合は、エージェント自身がローカル環境を使用可能な状態にする必要があります。エージェントが CLI やプラグインを直接インストールまたはアップグレードできる場合、まずユーザーにインストールを依頼してはいけません。 インストールまたはアップグレードにネットワークアクセス、sudo、またはツールの承認が必要な場合は、具体的なコマンドを示して承認を求め、承認後に続行してください。

必須条件:以下の準備状況の確認がすべて完了するまで、aliyun rdsai chat-messages を実行してはいけません。

  1. Alibaba Cloud CLI が存在し、aliyun version が 3.3.3 以上であること。
  2. プラグインの自動インストールが有効で、rdsai プロダクトプラグイン/コマンドを使用できること。
  3. Alibaba Cloud CLI の認証情報が設定され、選択したプロファイルが有効であること。

いずれかの条件を満たさない場合:

  • CLI がない、または古い場合:Alibaba Cloud CLI をインストールまたはアップグレードし、その後 aliyun version を再実行します。
  • rdsai プラグインがない場合:プラグインの自動インストールを有効にし、rdsai をインストールするか、インストールを開始してから、コマンドを再確認します。
  • 認証情報がない、または無効な場合:RDS Copilot API の呼び出し前に停止し、認証情報の設定方法をユーザーに案内します。ユーザーがエージェントによる設定を依頼した場合は、必要な項目だけを確認し、aliyun configure を使って設定します。環境変数にシークレットを貼り付けるようユーザーに求めてはいけません。

デフォルトのリージョン:ユーザーがリージョンを明示しない場合は、必ず cn-hangzhou を使用します。自然言語の「Hangzhou」は cn-hangzhou に対応します。ユーザーが別のリージョンを指定しない限り、--inputs RegionId=cn-hangzhou と認証情報の設定案内の両方で、このデフォルトを維持してください。


インストール

エージェントの事前確認:Alibaba Cloud CLI はインストール済みであるか、エージェントがインストールする必要があります

このスキルは、RdsAi OpenAPI の呼び出しに Alibaba Cloud CLI を使用します。エージェントはまず CLI が利用可能かどうかを確認する必要があります。CLI がなく、コマンドを実行できる場合は、ユーザーに手動での操作を依頼する前にインストールしてください。

事前確認:Aliyun CLI 3.3.3 以上が必要です

command -v aliyun と aliyun version を実行し、3.3.3 以上であることを確認します。 インストールされていない、またはバージョンが古い場合は、続行する前にインストールまたは更新してください。 CLI のバージョンが 3.3.0 未満の場合、aliyun plugin コマンドはサポートされません。プラグインコマンドを繰り返し実行するのではなく、まず CLI をアップグレードしてください。

事前確認:Aliyun CLI プラグインの更新が必要です

[必須] aliyun configure set --auto-plugin-install true を実行し、自動プラグインインストールを有効にしてください。 [必須] aliyun plugin list、aliyun plugin search rdsai、または aliyun rdsai --help を使って、rdsai プラグインの機能を確認してください。 [必須] rdsai がインストールされていない場合は、aliyun plugin install --names rdsai を実行し、再確認してください。 [必須] プラグインがすでにインストールされている場合は、aliyun plugin update --name rdsai を実行してください。CLI が aliyun plugin update のみをサポートしている場合は、そちらを使用して続行してください。

[必須] CLI User-Agent — aliyun rdsai chat-messages を呼び出すたびに、次の形式のコマンドごとの --user-agent 値を含める必要があります: AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}。 session-id の生成規則については、可観測性のセクションを参照してください。補助的な aliyun rdsai get-chat-model コマンドを使用する場合も、同じ User-Agent の規則に従います。aliyun configure、aliyun plugin、aliyun version などのシステムコマンドや、インストール/アップグレードコマンドには --user-agent を指定しないでください。

macOS のインストール
# Option 1: Install via Homebrew (recommended)
brew install aliyun-cli

# Option 2: Install via PKG package
curl -O https://aliyuncli.alicdn.com/aliyun-cli-latest.pkg
sudo installer -pkg aliyun-cli-latest.pkg -target /

# Option 3: Install via one-click script
/bin/bash -c "$(curl -fsSL https://aliyuncli.alicdn.com/install.sh)"
Linux のインストール
# Install via one-click script
/bin/bash -c "$(curl -fsSL https://aliyuncli.alicdn.com/install.sh)"

# Or download TGZ package for manual installation
curl https://aliyuncli.alicdn.com/aliyun-cli-linux-latest-amd64.tgz -o aliyun-cli.tgz
tar xzvf aliyun-cli.tgz
sudo mv aliyun /usr/local/bin/
インストールの確認
command -v aliyun
aliyun version

認証情報の設定

オプション 1:対話形式で設定(推奨)
aliyun configure --mode AK --profile rdsai

プロンプトに従って、次の情報を入力します。

  • Access Key Id:AccessKey ID
  • Access Key Secret:AccessKey Secret
  • Default Region Id:ユーザーが別のリージョンを指定しない場合は cn-hangzhou

ユーザーにシークレットを尋ねる前に、推奨される対話形式のコマンドではシークレットが Alibaba Cloud CLI の認証情報ストア内に保持されることを説明してください。チャット履歴にシークレットを必要以上に長く表示したり、保存したりしないでください。

オプション 2:非対話形式で設定
aliyun configure set \
  --profile rdsai \
  --mode AK \
  --access-key-id <yourAccessKeyID> \
  --access-key-secret <yourAccessKeySecret> \
  --region cn-hangzhou

コマンド形式

基本的なコマンド構造
aliyun rdsai chat-messages \
  --query '<query content>' \
  --inputs RegionId=cn-hangzhou Language=zh-CN Timezone=Asia/Shanghai [CustomAgentId=<custom agent ID>] [EnableThinking=<true|false>] [ThinkEffort=<default|high|low>] [ModelId=<model ID>] \
  --event-mode separate \
  --endpoint rdsai.aliyuncs.com \
  --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}' \
  [--conversation-id '<conversation ID>']
パラメーターの説明

重要:パラメーターの確認 — コマンドを実行する前に、 ユーザーの意図(SQL の作成/最適化、SQL の診断、インスタンスパラメーターの調整、トラブルシューティング、パフォーマンス分析、インスタンス一覧の照会など)を確認してください。 必要なパラメーターを収集してください(指定がない場合はデフォルト値を使用します)。

パラメーター必須/任意説明デフォルト
--query必須ユーザーのクエリ内容-
--inputs RegionId=任意Alibaba Cloud のリージョン IDcn-hangzhou
--inputs Language=任意言語zh-CN
--inputs Timezone=任意タイムゾーンAsia/Shanghai
--inputs CustomAgentId=任意カスタムエージェント IDNone
--inputs EnableThinking=任意深い思考モードの切り替え:true(有効)または false(無効)None
--inputs ThinkEffort=任意思考の深さ:default(自動)、high(より深い推論)、low(より速い応答)。サポートされる値はモデルによって異なります。get-chat-model のレスポンスにある ThinkingLevels を参照してくださいNone
--inputs ModelId=任意応答モデルのモデル ID。明示的に設定する場合は、chat-messages を呼び出す前に補助コマンド aliyun rdsai get-chat-model で [必ず] 検証してください。記憶に頼ったり、ハードコードされたモデル一覧を使用したりしないでくださいNone
--event-mode任意イベントモードseparate
--endpoint必須API エンドポイントrdsai.aliyuncs.com
--conversation-id任意複数ターンの対話に使用する会話 IDNone
--region任意API 呼び出しに使用するリージョン認証情報のデフォルトリージョン
--profile任意認証情報プロファイル名の指定デフォルトプロファイル
--user-agentビジネス API コマンドでは必須カスタム User-AgentAlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}

RAM 権限

このスキルには、次の RAM 権限が必要です。詳細については、references/ram-policies.md を参照してください。

権限説明
rdsai:ChatMessagesRDS AI Assistant の対話 API を呼び出す
rdsai:GetChatModel補助機能:ModelId を明示的に設定する際に、利用可能なチャットモデルを照会する

コアワークフロー

0. 環境準備の事前確認(RDS Copilot の呼び出し前)

すべての RDS Copilot タスクの開始時に、この事前確認を一度実行してください。ユーザーの依頼が単純な質問だからといって、省略しないでください。

# 0.1 Check Alibaba Cloud CLI existence and version
command -v aliyun
aliyun version

aliyun が見つからない場合は、利用できる最も安全なローカルの方法を選んでインストールしてください。

# macOS, when Homebrew is available
brew install aliyun-cli

# macOS/Linux fallback
/bin/bash -c "$(curl -fsSL https://aliyuncli.alicdn.com/install.sh)"

aliyun version が 3.3.3 未満の場合は、プラグインコマンドを実行する前にアップグレードしてください。

# CLI 3.3.5+ non-Homebrew install
aliyun upgrade --yes

# macOS Homebrew install
brew update
brew upgrade aliyun-cli

# Fallback for old CLI versions such as 3.0.x that do not support plugin commands
/bin/bash -c "$(curl -fsSL https://aliyuncli.alicdn.com/install.sh)"

インストールまたはアップグレード後、aliyun version を再実行してください。

# 0.2 Enable and verify plugin support. These are system commands; do not add --user-agent.
aliyun configure set --auto-plugin-install true
aliyun plugin list
aliyun plugin search rdsai

# Run only if the previous checks do not show the rdsai plugin/command.
aliyun plugin install --names rdsai

# Final capability check. This may also trigger auto-install after auto-plugin-install is enabled.
aliyun rdsai --help

aliyun plugin が 'plugin' is not a valid command or product などのエラーを返す場合、CLI が古すぎます。まず CLI をアップグレードし、プラグインコマンドの再試行を続けないでください。

# 0.4 Check credentials before the first API call
aliyun configure list

次の認証情報の状態は、準備未完了として扱ってください。

  • プロファイルが一覧に表示されない。
  • 選択中またはデフォルトのプロファイルで Credential が空になっている。
  • Valid が Invalid になっている、または有効であることが示されていない。
  • コマンドで unknown profile、InvalidAccessKeyId、SignatureDoesNotMatch、AccessKey の不足、期限切れの STS トークン、または同様の認証エラーが報告される。

認証情報の準備ができていない場合は、aliyun rdsai chat-messages を実行する前に停止し、認証情報の設定方法を案内してください。

# Recommended interactive setup
aliyun configure --mode AK --profile rdsai

# Non-interactive setup if the user explicitly asks the agent to configure credentials
aliyun configure set \
  --profile rdsai \
  --mode AK \
  --access-key-id <AccessKeyId> \
  --access-key-secret <AccessKeySecret> \
  --region cn-hangzhou

ユーザーがエージェントによる認証情報の設定を希望する場合は、次の情報を尋ねてください。

  • 認証情報のモード:ユーザーが OAuth、STS、RAM ロール、EcsRamRole、またはその他のサポート対象モードを指定しない限り、AK をデフォルトにします。
  • プロファイル名:rdsai をデフォルトにします。
  • AK モードの場合は AccessKeyId と AccessKeySecret、STS/RAM ロールモードの場合は各モード固有のフィールド。
  • 一時的な認証情報を使用する場合は STS トークン。
  • RegionId:指定がない場合は cn-hangzhou をデフォルトにします。

通常の設定方法として export ALIBABA_CLOUD_ACCESS_KEY_ID=... や export ALIBABA_CLOUD_ACCESS_KEY_SECRET=... を決して使用しないでください。認証情報を CLI の認証情報ストアに保存するため、aliyun configure を使用してください。

1. タスクの種類とパラメーターを確認する

ユーザーの意図を特定します。SQL の作成/最適化、SQL の診断、インスタンスパラメーターのチューニング、トラブルシューティング、パフォーマンス分析、クエリーインスタンス一覧の取得などが該当します。

必要なパラメーターを収集します(指定がない場合はデフォルト値を使用します)。

  • RegionId:リージョン ID(デフォルトは cn-hangzhou。省略時はこれを使用します)
  • Language:言語(デフォルトは zh-CN)
  • Timezone:タイムゾーン(デフォルトは Asia/Shanghai)
  • CustomAgentId:カスタムエージェント ID(任意)
  • EnableThinking:深い思考モードの切り替え。true または false(任意。ユーザーが深い思考または簡潔な回答を求めない限り、省略します)
  • ThinkEffort:思考の深さ(任意。default は自動、high は複雑な診断/最適化向けの深い推論、low は迅速な回答です。各モデルがサポートする値は、get-chat-model の ThinkingLevels に返されます)
  • ModelId:モデル ID(任意。ユーザーがモデルを明示的に指定した場合にのみ使用します)。明示的に指定された場合は、ChatMessages を呼び出す前に、必ず最初に補助 GetChatModel API を呼び出し、ID が Data[].ModelId に含まれていることを確認してください。これは qwen3.8-max などのよく知られたものも含め、ユーザーが指定したすべてのモデル ID に適用されます。確認を省略したり、記憶やハードコードされたモデル一覧に頼ったりしないでください。ModelId を省略した場合、照会は不要です。その場合、サービスは GetChatModel の応答で Default=true とマークされたモデルを使用します。将来互換性:API が対応すると、新しいモデル ID は GetChatModel の応答に自動的に表示されます。GetChatModel で確認してから渡してください。スキルの設定やコードを変更する必要はありません
  • --conversation-id:複数ターンの対話用の会話 ID(任意)

GetChatModel はメインの呼び出しフローを補助する確認です。ChatMessages 自体はこれがなくても動作しますが、次のいずれかに該当する場合は、aliyun rdsai chat-messages の実行前に必ず確認してください。

  1. ユーザーがモデル ID を明示的に指定した場合。qwen3.8-max などのよく知られたものを含め、すべてのモデル ID が対象です。その ID が Data[].ModelId に含まれていることを確認してください。モデルがすでにサポートされていると思い込んで確認を省略したり、記憶やハードコードされたモデル一覧に頼ったりしないでください。
  2. ユーザーが利用可能なモデルを尋ねた場合。
  3. ユーザーが深い思考または特定の思考の深さ(EnableThinking/ThinkEffort)を要求した場合。サポートされる ThinkEffort の値はモデルごとに異なり、get-chat-model の応答にある ThinkingLevels から読み取る必要があります。

上記のいずれにも該当しない場合(モデルの指定がなく、モデル一覧についての質問も、思考の深さの要求もない場合)に限り、get-chat-model を省略できます。

aliyun rdsai get-chat-model \
  --endpoint rdsai.aliyuncs.com \
  --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}'

応答の Data 配列には、現在サポートされているすべてのモデルと、その ModelId、Default、ThinkingLevels、Features、ContextWindow が一覧表示されます。ユーザーが指定したモデル ID が Data[].ModelId にない場合は、利用可能なモデルを提示し、いずれかを選ぶようユーザーに依頼してください。

2. コマンドを構成して CLI を呼び出す

この手順は、環境の準備確認が成功した後にのみ実行してください。また、ユーザーがモデル ID または思考の深さを指定した場合は、必須の aliyun rdsai get-chat-model による確認が成功した後にのみ実行してください。必ず RegionId を指定してください。ユーザーがリージョンを指定しない場合は、cn-hangzhou を使用します。 最初のビジネス API 呼び出しの前に、以下のオブザーバビリティのルールに従って session-id を 1 つ生成し、この RDS Copilot タスクのすべての aliyun rdsai chat-messages 呼び出しで再利用してください。

# Basic query
aliyun rdsai chat-messages \
  --query 'List RDS MySQL instances in Hangzhou region' \
  --inputs RegionId=cn-hangzhou Language=zh-CN Timezone=Asia/Shanghai \
  --event-mode separate \
  --endpoint rdsai.aliyuncs.com \
  --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}'

# Troubleshooting example
aliyun rdsai chat-messages \
  --query 'RDS instance rm-bp1xxx connection timeout, error Too many connections, please help troubleshoot. Instance is in Hangzhou region.' \
  --inputs RegionId=cn-hangzhou Language=zh-CN Timezone=Asia/Shanghai \
  --event-mode separate \
  --endpoint rdsai.aliyuncs.com \
  --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}'

# Query with Beijing region
aliyun rdsai chat-messages \
  --query 'Optimize this SQL: SELECT * FROM users WHERE name LIKE "%test%"' \
  --inputs RegionId=cn-beijing Language=zh-CN Timezone=Asia/Shanghai \
  --event-mode separate \
  --endpoint rdsai.aliyuncs.com \
  --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}'

# Multi-turn dialogue (using ConversationId from previous response)
aliyun rdsai chat-messages \
  --query 'Continue analyzing the above issue' \
  --conversation-id '<ConversationId from previous response>' \
  --inputs RegionId=cn-hangzhou Language=zh-CN Timezone=Asia/Shanghai \
  --event-mode separate \
  --endpoint rdsai.aliyuncs.com \
  --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}'

# Using custom Agent
aliyun rdsai chat-messages \
  --query 'Analyze database performance' \
  --inputs RegionId=cn-hangzhou Language=zh-CN Timezone=Asia/Shanghai CustomAgentId=your-custom-agent-id \
  --event-mode separate \
  --endpoint rdsai.aliyuncs.com \
  --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}'

# Deep thinking mode with explicit model and thinking depth (optional parameters)
# [MUST] The user explicitly sets ModelId and thinking depth, so first verify the model with get-chat-model,
# for EVERY user-specified model ID (including well-known ones such as qwen3.8-max), then call chat-messages;
# to switch models, re-verify with get-chat-model and change only the ModelId value
aliyun rdsai get-chat-model \
  --endpoint rdsai.aliyuncs.com \
  --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}'

aliyun rdsai chat-messages \
  --query 'Diagnose slow SQL on the instance and provide an optimization plan. Instance is in Hangzhou region.' \
  --inputs RegionId=cn-hangzhou Language=zh-CN Timezone=Asia/Shanghai EnableThinking=true ThinkEffort=high ModelId=qwen3.8-max \
  --event-mode separate \
  --endpoint rdsai.aliyuncs.com \
  --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}'
3. 結果の解析と後続処理
  • 応答またはユーザーが貼り付けたエラーに No valid order found が含まれる場合に限り、通常の結果解析を中止し、次のガイダンスをそのままユーザーに返します。
    • 今回の呼び出しでは、有効な RDS AI Assistant Professional Edition の注文が見つかりませんでした。現在の Alibaba Cloud アカウントで RDS AI Assistant Professional Edition を有効化してから、失敗した呼び出しを再試行してください。
    • 有効化ページ:https://rdsnext.console.aliyun.com/rdsCopilotProfessional/cn-hangzhou
    • 操作ガイド:https://help.aliyun.com/zh/rds/apsaradb-rds-for-mysql/manage-rds-colipot-professional-edition
    • 操作ガイドに従い、RDS コンソールで RDS AI Assistant > Professional Edition を選択して Activate Now をクリックし、RDS AI Assistant Professional Edition を作成してください。有効化が成功したら、有効化したアカウントで失敗した呼び出しを再試行してください。
  • 応答が別のエラーコードで失敗した場合は、再試行する前に、ユーザー向けのガイダンスに置き換えます。
    • ContentModeration(HTTP 451):リクエストに不適切なコンテンツが含まれています。クエリを言い換えるようユーザーに依頼してください。
    • InvalidParameter(HTTP 400):1 つ以上のパラメーターが無効です。EnableThinking、ThinkEffort、ModelId などの --inputs の値を確認して修正してから、再試行してください。サポートされていない ModelId が原因の場合は、aliyun rdsai get-chat-model を実行して現在サポートされているモデルを取得し、リストから選ぶようユーザーに案内するか、最新のサポート対象モデルを確認するためテクニカルサポートに問い合わせてください。
    • UserNotFound(HTTP 404):ユーザーが存在しません。CLI の認証情報設定とアカウントを確認してください。
    • TooManyRequests(HTTP 429):同時リクエスト数の上限を超えています。しばらく待ってから再試行するか、同時実行数の上限を引き上げるために AI キャパシティパックの購入を提案してください。
    • MoQuotaExceeded(HTTP 429):ルーティング先の Standard インスタンスの MO トークン割り当てを使い切ったため、リクエストがレート制限されています。割り当てが回復するまで待つか、キャパシティパックの購入を提案してください。
  • RDS Copilot の応答を自然な言葉でユーザーに説明します
  • 応答に SQL または操作手順が含まれる場合は、リスクを評価して警告します。
    • 本番環境で高リスクのステートメント(大規模なテーブルの DELETE/UPDATE、スキーマ変更など)を直接実行しないでください。
    • テスト環境での検証、またはバックアップや条件による制限を設けることを推奨してください。
  • 会話を続ける場合は、次のクエリに使用するため、応答の ConversationId を記録します

可観測性

最初のビジネス API 呼び出しの前に、RDS Copilot のタスク/セッションごとに 1 つの session-id を生成します。session-id は 32 文字の小文字の 16 進数文字列とし、同じタスク内のすべての aliyun rdsai chat-messages コマンド(複数ターンの後続処理を含む)で生成した値を再利用します。補助コマンド aliyun rdsai get-chat-model を使用する場合も、同じ session-id を再利用します。

推奨される生成方法:

openssl rand -hex 16

代替方法:

python3 -c 'import secrets; print(secrets.token_hex(16))'

User-Agent のテンプレート:

AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}

この User-Agent は、ビジネス API コマンドの --user-agent 引数としてのみ、コマンドごとに指定します。

aliyun rdsai chat-messages \
  --query '<query content>' \
  --inputs RegionId=cn-hangzhou Language=zh-CN Timezone=Asia/Shanghai \
  --event-mode separate \
  --endpoint rdsai.aliyuncs.com \
  --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}'

非推奨のグローバル User-Agent 設定方法は使用しないでください。aliyun configure、aliyun plugin、aliyun version、command -v aliyun などのシステムコマンド、インストールコマンド、アップグレードコマンドには --user-agent を追加しないでください。


出力形式

Alibaba Cloud CLI は JSON 形式の応答を返します(複数の JSON イベントをストリーミングします)。

{"data":{"ConversationId":"8227be22-xxxx-xxxx-xxxx-xxxxxxxxxxxx","Event":"workflow_started","MessageId":"a79c881c-xxxx-xxxx-xxxx-xxxxxxxxxxxx",...}}
{"data":{"Answer":"<partial answer content>","Event":"message",...}}
{"data":{"Event":"workflow_finished",...}}

主なフィールド:

  • ConversationId:会話 ID(複数ターンの対話用)
  • Answer:AI アシスタントの応答内容
  • Event:イベントの種類(workflow_started、message、workflow_finished)

成功の確認

  1. CLI のインストール成功:aliyun version にバージョン番号が表示される
  2. 認証情報の正しい設定:aliyun configure list に設定済みの認証情報が表示される
  3. オブザーバビリティの正しい設定:ビジネス API 呼び出しに、32 文字の 16 進数の session-id を含む --user-agent 'AlibabaCloud-Agent-Skills/alibabacloud-rds-copilot/{session-id}' が指定されている
  4. API 呼び出しの成功:レスポンスに JSON 形式の ConversationId と Answer が含まれる
  5. レスポンス内容の妥当性:回答がクエリ内容に関連している

詳しい確認手順については、references/verification-method.md を参照してください。


クリーンアップ

このスキルは読み取り専用のクエリ操作のみを実行し、クラウドリソースを作成しないため、クリーンアップは不要です。


API とコマンドの一覧

詳細については、references/related-apis.md を参照してください。

プロダクトAPI アクションCLI コマンド説明
RdsAiChatMessagesaliyun rdsai chat-messagesRDS AI アシスタントの対話 API
RdsAiGetChatModelaliyun rdsai get-chat-model補助:ModelId を明示的に設定する場合に、利用可能なチャットモデルを照会

ベストプラクティス

  1. 複数ターンの対話を使用する:複雑な問題では、--conversation-id を使用してコンテキストを考慮した複数ターンの会話を行います
  2. 正しいリージョンを指定する:RDS インスタンスのリージョンに基づいて RegionId パラメーターを設定します
  3. 本番環境では慎重に扱う:RDS Copilot の SQL 提案は、まずテスト環境で検証してください
  4. 会話 ID を保存する:追加の問い合わせや分析の続行が必要な場合に備えて、返された ConversationId を保存します
  5. 設定ファイルを使用する:認証情報の設定には aliyun configure の使用を推奨します。コマンドラインでの機密情報の露出を避けられます
  6. --profile を使用する:複数の認証情報プロファイルを設定し、--profile を使用してアカウントを切り替えられます

参考リンク

参考ドキュメント説明
Alibaba Cloud CLI DocumentationAlibaba Cloud CLI ユーザーガイド
references/related-apis.mdAPI とコマンドの一覧
references/ram-policies.mdRAM ポリシーの設定
references/verification-method.md確認方法
references/acceptance-criteria.md受け入れ基準

コメント