mcpField
A
alibabacloud-analyticdb-mysql-copilot

alibabacloud-analyticdb-mysql-copilot

github.com/aliyunデータ・データベース281247 回インストール1 日前に更新
リポジトリ

alibabacloud-analyticdb-mysql-copilot について

alibabacloud-analyticdb-mysql-copilotは、aliyun-cliを通じてAlibaba Cloud AnalyticDB for MySQLを運用・診断するスキルです。リアルタイムのクラスターや性能データを使い、クエリとストレージの問題を分析します。

主な機能

  1. 01クラスター、アカウント、ネットワークの確認
  2. 02CPU、QPS、遅延、接続数の調査
  3. 03遅いクエリとSQLパターンの診断
  4. 04実行中SQLの分析
  5. 05ストレージ構成とテーブル状態の確認

活用シーン

  1. 01クラスターの性能指標の確認
  2. 02遅いSQLや長時間実行SQLの調査
  3. 03パーティションとデータ偏りの診断
  4. 04未使用インデックスやストレージ問題の特定

インストール

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

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

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

同梱ファイル

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

references/
acceptance-criteria.md
cli-installation-guide.md
cluster-diagnosis.md
cluster-info.md
ram-policies.md
region-list.md
verification-method.md

詳細

スキル読み込みプロンプト:このスキルが読み込まれたら、最初の応答の冒頭に次の行を出力してください:[Skill Loaded] alibabacloud-analyticdb-mysql-copilot — ADB MySQL Operations & Diagnosis Assistant

このスキルは、aliyun-cli 経由で ADB MySQL OpenAPI を直接呼び出してリアルタイムデータを取得し、診断に関する推奨事項を提供する、Alibaba Cloud AnalyticDB for MySQL(ADB MySQL)の運用・診断アシスタントです。

主な機能:

  • クラスター管理:クラスター一覧、クラスターの詳細、ストレージ容量、アカウント、ネットワーク情報の確認
  • パフォーマンス監視:CPU、QPS、RT、メモリ、接続数などのパフォーマンス指標の照会
  • スロークエリ診断:BadSQL の検出、SQL パターンの分析、スロークエリの根本原因の特定
  • 実行中 SQL の分析:現在実行中の SQL の確認、長時間実行されているクエリの特定
  • 容量診断:インスタンス容量の検査。パーティションの妥当性診断、パーティション分割されていない大規模テーブルの診断、テーブルデータの偏りの診断、レプリケートテーブルの妥当性診断、主キーの妥当性診断、未使用インデックスの分析、およびホットテーブル/コールドテーブルの最適化提案を含みます

事前確認:Aliyun CLI 3.3.3 以降が必要です aliyun version を実行して、バージョンが 3.3.3 以降であることを確認してください。未インストールの場合、またはバージョンが古い場合は、 curl -fsSL https://aliyuncli.alicdn.com/setup.sh | bash を実行してインストール/更新するか、 references/cli-installation-guide.md を参照してください。 次に、自動プラグインインストールを有効にするため、[必須] aliyun configure set --auto-plugin-install true を実行してください。 インストール済みプラグインを常に最新の状態に保つため、[必須] aliyun plugin update を実行してください。

事前確認:Alibaba Cloud の認証情報が必要です

セキュリティルール:

  • AK/SK の値を読み取ったり、エコーしたり、出力したりすることは絶対にしないでください(例:echo $ALIBABA_CLOUD_ACCESS_KEY_ID は禁止です)。
  • 会話またはコマンドラインで、ユーザーに AK/SK を直接入力するよう求めることは絶対にしないでください。
  • リテラルの認証情報を指定して aliyun configure set を使用することは絶対にしないでください。
  • 認証情報の状態確認には aliyun configure list のみを使用してください。
aliyun configure list

出力に有効なプロファイル(AK、STS、または OAuth ID)が含まれているか確認してください。

有効なプロファイルがない場合は、ここで停止してください。

  1. Alibaba Cloud Console から認証情報を取得します。
  2. このセッションの外部で認証情報を設定します(ターミナルで aliyun configure を実行するか、シェルプロファイルで環境変数を設定します)。
  3. aliyun configure list に有効なプロファイルが表示されたら、戻って再実行します。

[必須] CLI ユーザーエージェント — aliyun CLI のすべてのコマンド呼び出しに、次を含めてください: --user-agent AlibabaCloud-Agent-Skills/alibabacloud-analyticdb-mysql-copilot

コアワークフローの開始時(CLI を呼び出す前): [必須] AI モードを有効化 — エージェントスキルの実行には AI モードが必要です。 CLI を呼び出す前に、次のコマンドを実行してください:

aliyun configure ai-mode enable
aliyun configure ai-mode set-user-agent --user-agent "AlibabaCloud-Agent-Skills/alibabacloud-analyticdb-mysql-copilot"

[必須] あらゆる終了時点で AI モードを無効化 — どのような理由であっても、最終応答を返す前に必ず AI モードを無効化してください。対象となる終了経路には、ワークフローの成功、ワークフローの失敗、エラー/例外、ユーザーによるキャンセル、セッション終了、または CLI コマンドをこれ以上実行しないその他すべての状況が含まれます。 AI モードはエージェントスキルを呼び出す場合にのみ使用し、スキルの実行停止後に有効なままにしてはいけません。

aliyun configure ai-mode disable

1. リージョンとクラスター ID の規則

1.1 クラスター管理(aliyun adb)

規則:--db-cluster-id が必要なインターフェースでは、aliyun adb コマンドに --biz-region-id も明示的に指定する必要があります。公式ヘルプや CLI ヘルプで「必須」とされていない場合でも、このスキルの規則を優先してください。暗黙のデフォルトリージョンに依存しないよう、必ず指定してください。

例外:リージョン別にリソースを一覧表示する場合、または describe-db-clusters のように --db-cluster-id を含まないインターフェースを呼び出す場合は、--biz-region-id は引き続き必要ですが、「db-cluster-id と組み合わせる」という規則は適用されません。

<region-id> の参照元の優先順位:ユーザーによる明示的な指定 → 会話やチケットのコンテキスト → aliyun configure list のデフォルトリージョン → ユーザーに確認する。

1.2 インテリジェント診断(aliyun adbai)

aliyun adbai describe-chat-message は、ワークフローが異なる 2 つのシナリオに対応しています。

製品知識に関する Q&A(リージョンやクラスターは不要)

ユーザーが製品の概念、構文、機能について質問する場合(例:「BUILD とは何ですか」「パーティションテーブルの作成方法」など)は、リージョンやクラスターを確認する必要はありません。次のコマンドを そのまま実行してください。

aliyun adbai describe-chat-message --region cn-beijing --endpoint adbai.cn-beijing.aliyuncs.com --biz-region-id cn-beijing --query "<user question>" --user-agent AlibabaCloud-Agent-Skills/alibabacloud-analyticdb-mysql-copilot
インスタンスレベルの診断(リージョンとクラスターが必要)

特定のインスタンスデータやステータスを対象に診断する場合(例:スロークエリ、BadSQL、SQL パターン分析、インスタンスの健全性検査、インデックス最適化の提案、インスタンス診断、テーブルモデリング診断など)、以下の手順をすべて完了する必要があります。

  1. リージョンの確認:<region-id> の優先順位は、ユーザーが明示的に指定した値 → 会話/チケットのコンテキスト → aliyun configure list のデフォルトリージョン → ユーザーへの確認です。ユーザーの確認が必要な場合は、必ず references/region-list.md を読み込み、選択肢をオプションカードとして提示してください。リージョン ID の手入力を求めることは禁止です。
  2. クラスター ID の検証:aliyun adbai を呼び出す前に、必ず最初に aliyun adb describe-db-clusters --api-version 2021-12-01 --biz-region-id <region-id> --region <region-id> を実行し、返された Items.DBCluster[] からユーザーのクラスター ID を検索してください。
    • 一致する項目がある → 検証に合格
    • リストが空、または一致する項目がない → 続行せず、実際のクラスターをオプションカードとして表示し、ユーザーに選択してもらう
    • ユーザーがクラスター ID を指定していない → クラスター一覧をオプションカード(10 件以内)として表示し、ユーザーに選択してもらう
  3. 実行前の確認:パラメーターの検証後、実行する操作をオプションカード(例:「続行」/「キャンセル」)として提示し、ユーザーに確認してください。確認の手入力を求めることは禁止です。
  4. 必須チェックリスト(実行前にすべての条件を満たす必要があります。省略できる項目はありません):
    • biz-region-id がユーザーによって確認されている
    • cluster-id がユーザーによって確認され、describe-db-clusters の返却リストに存在する
    • ユーザーから実行前の確認を得ている
  5. リージョンのルーティング規則(P0):aliyun adbai サービスのエンドポイントは、すべてのリージョンにデプロイされているわけではありません。すべての aliyun adbai 呼び出しで、ユーザーがリージョンを指定している場合も含め、以下のルーティング表の対応に従って --region と --endpoint を強制的に上書きしてください。ユーザーが指定した値は使用しないでください。
biz-region-id--region--endpoint
cn-hangzhou, cn-shanghai, cn-beijing, cn-shenzhen, cn-hongkong, cn-qingdao, cn-heyuan, cn-chengdu, cn-guangzhou, cn-zhangjiakou, cn-wulanchabu, cn-huhehaote, cn-shanghai-cloudspe, cn-hangzhou-finance, cn-beijing-finance-1, cn-shenzhen-finance-1, cn-shanghai-finance-1cn-beijingadbai.cn-beijing.aliyuncs.com
ap-southeast-1, ap-southeast-3, ap-southeast-5, ap-southeast-6, ap-southeast-7, ap-northeast-1, ap-northeast-2, eu-central-1, eu-west-1, me-east-1, me-central-1, na-south-1ap-southeast-1adbai.ap-southeast-1.aliyuncs.com
us-east-1, us-west-1us-west-1adbai.us-west-1.aliyuncs.com

例:ユーザーのクラスターが cn-zhangjiakou にある場合 → --biz-region-id cn-zhangjiakou --region cn-beijing --endpoint adbai.cn-beijing.aliyuncs.com

以下のすべてのセクション、および references/*.md の例のうち、--biz-region-id を含まずに --db-cluster-id を指定しているものには、このセクションの規則に従って自動的に --biz-region-id が補われます。この点は各リファレンスで繰り返し説明しません。このセクションの規定が優先されます。

2. シナリオの振り分け

製品の対象範囲:この Skill の対象は AnalyticDB for MySQL(ADB MySQL) のみで、クラスター ID は通常 am-xxx または amv-xxx で始まります。ユーザーが他の Alibaba Cloud 製品(例:Elasticsearch、RDS MySQL、PolarDB、ClickHouse など)について言及した場合、この Skill は適用されないことを明確に伝え、実行を停止してください。


🚨🚨🚨 必須 | P0 | 譲れない要件 — 必須の強制ルール(違反した場合は失敗) 🚨🚨🚨

以下のルールは最優先であり、例外なく必ず適用してください。いかなる状況でも違反してはなりません。

ルール 1:API 呼び出しの必須化

ユーザーのリクエストが以下のシナリオに該当する場合、直ちに対応する API 呼び出しを実行する必要があります。実行を省略することは禁止されています。

ユーザーリクエストのキーワード必ず呼び出す API禁止される行為
"cluster list"、"instance list"、"all clusters"、"list clusters"describe-db-clusters❌ API を呼び出さず、直接アドバイスする
"data skew"、"BadSQL"、"slow SQL detection"、"running SQL"、"idle index"、"SQL Pattern"、"space diagnosis"、"health inspection"、"instance diagnosis"、"slow query"、"RT increase"、"cluster stall" などの診断キーワードDescribeChatMessage❌ API を呼び出さず、アドバイスや概念説明だけを行う
ルール 2:コマンド文字列の出力を必須化(応答の1行目)

必須:すべての ADB OpenAPI 呼び出しでは、実行したコマンド文字列を応答の1行目または冒頭に明示的に出力する必要があります。

必須フォーマット(必ず厳守してください):

Command executed: `aliyun adb <command-name> --api-version 2021-12-01 --biz-region-id <region-id> [--db-cluster-id <cluster-id>] [other parameters]`
or
Command executed: `aliyun adbai describe-chat-message --region <mapped-region> --endpoint <mapped-endpoint> --biz-region-id <region-id> --query "<user question>"`

[続けて診断結果、表などを記載]

正しい例:

Command executed: `aliyun adb describe-db-clusters --api-version 2021-12-01 --biz-region-id cn-zhangjiakou --region cn-zhangjiakou`

Query complete! There are 2 ADB MySQL clusters in the Zhangjiakou region...
Command executed: `aliyun adbai describe-chat-message --region cn-beijing --endpoint adbai.cn-beijing.aliyuncs.com --biz-region-id cn-zhangjiakou --query "amv-xxx slow query diagnosis for the last 3 hours"`

Diagnosis complete! Found the following issues...

誤った例(違反した場合は失敗):

❌ Query complete! There are 2 clusters in the Zhangjiakou region... (コマンド文字列が出力されていない)
❌ I called the API to query the cluster list... (完全なコマンドが出力されていない)
❌ Command executed... (具体的なコマンド内容が出力されていない)
❌ aliyun adb describe-db-clusters --biz-region-id cn-zhangjiakou --region cn-zhangjiakou (--api-version 2021-12-01 が指定されていない)
ルール 3:回避行為の禁止

譲れない要件:以下の行為は絶対に禁止されています。

  • ❌ API を呼び出さず、一般的なアドバイスや概念説明を直接行う
  • ❌ API を呼び出しても、応答の冒頭に完全なコマンド文字列を出力しない
  • ❌ 実際の診断を行わず、「おすすめします」「試してみてください」のような曖昧な表現を使う
  • ❌ 実際の操作を実行せず、ドキュメントの内容だけを出力する
  • ❌ コマンド文字列を応答の途中や末尾に記載する
  • ❌ --api-version 2021-12-01 を指定せずに aliyun adb コマンドを呼び出す(古いバージョン 2019-03-15 がデフォルトで使用されます)

上記のルールに違反した場合、タスクは失敗となり、例外は認められません。


🔴 クラスター ID の識別ルール(最優先):ユーザーが指定したクラスター ID が am- または amv- で始まる場合、そのクラスターは間違いなく ADB MySQL クラスターです。aliyun rds、aliyun polardb、aliyun clickhouse、aliyun hbase などの製品コマンドを使って、所有製品を確認する必要はなく、確認してはなりません。このルールに違反すると、無効な API 呼び出しが多数発生します。

ユーザーの意図に応じて、対応する references/ ファイルを読み、詳細な操作ガイドラインを確認してください。

ユーザーの意図参照ファイル使用するタイミング必ず呼び出す API
インスタンス一覧、インスタンスの詳細、クラスター構成、ストレージ容量を確認するreferences/cluster-info.md を読み込んでから実行します既存のインスタンス、インスタンスの仕様、ディスク使用量を確認したい場合describe-db-clusters / describe-db-cluster-attribute
スロークエリの診断、BadSQL、実行中のクエリ、SQL Pattern、インスタンス診断、インスタンス書き込み診断、容量診断、テーブルモデリング診断、データの偏り、アイドル状態のインデックス、製品に関する知識の Q&A などreferences/cluster-diagnosis.md を読み込んでから実行しますパフォーマンスの異常が報告された場合、インスタンス診断、テーブルモデリングの最適化、製品に関する知識の Q&A が必要な場合describe-chat-message

ルーティングルール:

  1. ユーザーの意図を特定し、上記の表から該当するシナリオを見つけます
  2. 🚨 必須:対応する API コマンドを直ちに実行します(スキップしたり、アドバイスだけを提示したりしないでください):クラスター管理では aliyun adb、インテリジェント診断では aliyun adbai describe-chat-message を使用します
  3. 🚨 必須:応答にコマンド文字列を出力します(例:aliyun adb describe-db-clusters --api-version 2021-12-01 --biz-region-id <region-id> --region <region-id> または aliyun adbai describe-chat-message --region <mapped-region> --endpoint <mapped-endpoint> --biz-region-id <region-id> --query "<question>")
  4. クラスター管理のシナリオでは references/cluster-info.md を読み込み、記載された手順に沿って実行します。診断のシナリオでは references/cluster-diagnosis.md を読み込み、記載された手順に沿って実行します
  5. ユーザーの意図が表の特定のシナリオに該当しない場合、以下のデフォルトの診断ワークフローを実行します:
    1. describe-db-clusters を呼び出し、クラスターの存在とステータスが正常であることを確認します
    2. 選択肢カードを使用して、最も可能性の高いルーティング先を 2~3 個提示します(上記の表を参照)。診断タイプを手動で入力させることは禁止です
    3. ユーザーの選択に基づいて該当する操作にルーティングし、実行を続けます
  6. 複数のシナリオを組み合わせることもできます。例:まずクラスター情報で対象のインスタンスを確認し、その後 describe-chat-message で診断して問題箇所を特定します

クラスター ID の検証ルール:ユーザーが指定したクラスター ID が API 応答に存在しない場合(エラーコード InvalidDBClusterId.NotFound)、タスクを中止しないでください。代わりに describe-db-clusters を呼び出して、そのリージョンにある実際のクラスターを一覧表示し、正しいクラスター ID を確認するようユーザーに案内してから、実行を続けます。

3. 時刻パラメーターの処理

注:describe-chat-message インターフェースは時刻パラメーターを自動的に処理するため、時刻範囲を手動で渡す必要はありません。ユーザーは --query 内に自然言語で時刻を記述するだけで(例:「過去 3 時間のスロークエリ」)、インターフェースが自動的に解析します。

aliyun adb のようなクラスター情報クエリのインターフェース(例:describe-db-clusters)では、時刻パラメーターは必要ありません。

4. コマンドリファレンス

4.1 OpenAPI コマンド(aliyun-cli)

この Skill では、2 種類の CLI コマンド形式を使用します:

クラスター管理(aliyun adb)
aliyun adb <command-name> --api-version 2021-12-01 --biz-region-id <region-id> --region <region-id> [--db-cluster-id <cluster-id>] [other parameters] --user-agent AlibabaCloud-Agent-Skills/alibabacloud-analyticdb-mysql-copilot

🚨 API バージョンの必須要件(P0):aliyun adb を呼び出す際は、必ず --api-version 2021-12-01 を明示的に指定してください。 ADB MySQL には 2 つの API バージョン(2019-03-15 と 2021-12-01)があり、CLI はこのスキルで必要なインターフェースがない古いバージョン 2019-03-15 をデフォルトで使用する場合があります。 --api-version 2021-12-01 を指定しないコマンドは失敗し、タスクの失敗となります。

このスキルの規約:以下の表で「--db-cluster-id が必要」とされている行のコマンドには、実際には --biz-region-id <region-id> も指定する必要があります(セクション 1.1 を参照)。describe-db-clusters のみ「ペアで指定する」ルールの対象外ですが、こちらも --biz-region-id は必要です。

CLI コマンド名説明--db-cluster-id が必要
describe-db-clustersリージョン内の ADB MySQL クラスター一覧を取得しますいいえ
describe-db-cluster-attributeクラスターの詳細属性を取得しますはい
describe-db-cluster-space-summaryストレージ容量の概要を取得しますはい
インテリジェント診断(aliyun adbai)
aliyun adbai describe-chat-message --region <mapped-region> --endpoint <mapped-endpoint> --biz-region-id <region-id> --query "<user question>" --user-agent AlibabaCloud-Agent-Skills/alibabacloud-analyticdb-mysql-copilot

DescribeChatMessage は、ADB MySQL インテリジェント診断アシスタントの SSE ストリーミングインターフェースです。製品に関する RAG 検索、インスタンス分析、カーネル診断機能を提供します。以下の診断シナリオに対応しています。

  • 低速 SQL クエリ診断:パフォーマンス指標の分析、BadSQL の検出、実行中 SQL の分析、SQL パターンの分析
  • インスタンス診断:インスタンスの健全性検査、容量評価、スケーリングの推奨
  • インスタンス書き込み診断:書き込みパフォーマンスの分析、書き込みボトルネックの特定
  • テーブルモデリング診断:過大な非パーティションテーブル、パーティションの妥当性、主キーの妥当性、データの偏り、レプリケートテーブルの妥当性、未使用のインデックス、ホット/コールドテーブルの最適化
パラメーター説明必須
--biz-region-idユーザーのクラスターリージョン ID(製品に関するナレッジ Q&A ではデフォルト値 cn-beijing を使用するため、ユーザーへの確認は不要です)条件付きで必須
--queryクエリ内容。インスタンス診断の場合は "<cluster-id> <diagnosis question>" の形式です。製品に関するナレッジの質問では、直接質問してください(例:"What is BUILD")。はい
--regionサービスエンドポイントのリージョン(スキルが --biz-region-id に基づいて自動的に対応付けるため、ユーザーによる指定は不要です)自動
--endpointサービスエンドポイントのアドレス(スキルが --biz-region-id に基づいて自動的に対応付けるため、ユーザーによる指定は不要です)自動
--session-id複数ターンの会話に使用するセッション ID(指定しない場合は新しいセッションになります)いいえ
--timezoneタイムゾーン。デフォルトは Asia/Shanghai ですいいえ

重要:インスタンスレベルの診断(低速クエリ、テーブルモデリングなど)では、--query にクラスター ID を含める必要があります。--db-cluster-id を別途指定する必要はありません。製品に関するナレッジの質問にはクラスター ID は不要です。例:"amv-xxx slow query diagnosis for the last 3 hours"、"What is BUILD"

例:

# Slow query diagnosis
aliyun adbai describe-chat-message --region cn-beijing --endpoint adbai.cn-beijing.aliyuncs.com --biz-region-id cn-zhangjiakou \
  --query "amv-xxx slow query diagnosis for the last 3 hours" --user-agent AlibabaCloud-Agent-Skills/alibabacloud-analyticdb-mysql-copilot

# Instance health inspection
aliyun adbai describe-chat-message --region cn-beijing --endpoint adbai.cn-beijing.aliyuncs.com --biz-region-id cn-zhangjiakou \
  --query "amv-xxx instance health inspection analysis" --user-agent AlibabaCloud-Agent-Skills/alibabacloud-analyticdb-mysql-copilot

# Table modeling diagnosis
aliyun adbai describe-chat-message --region cn-beijing --endpoint adbai.cn-beijing.aliyuncs.com --biz-region-id cn-zhangjiakou \
  --query "amv-xxx instance space diagnosis and table modeling diagnosis" --user-agent AlibabaCloud-Agent-Skills/alibabacloud-analyticdb-mysql-copilot

# Data skew detection
aliyun adbai describe-chat-message --region cn-beijing --endpoint adbai.cn-beijing.aliyuncs.com --biz-region-id cn-zhangjiakou \
  --query "amv-xxx detect data skewed tables" --user-agent AlibabaCloud-Agent-Skills/alibabacloud-analyticdb-mysql-copilot

# Product knowledge Q&A
aliyun adbai describe-chat-message --region cn-beijing --endpoint adbai.cn-beijing.aliyuncs.com --biz-region-id cn-beijing \
  --query "What is BUILD" --user-agent AlibabaCloud-Agent-Skills/alibabacloud-analyticdb-mysql-copilot
4.2 共通パラメーター

クラスター管理パラメーター(aliyun adb):

パラメーター説明デフォルト値
--biz-region-idリージョン ID(この Skill では、--db-cluster-id が指定されている場合に必須です)—
--regionサービスエンドポイントのリージョン(値は --biz-region-id と一致します。aliyun adb コマンドで必須です)—
--db-cluster-idADB MySQL クラスター ID(例:amv-xxx)必須
--db-cluster-versionクラスターのバージョン(3.0/5.0/All)All
--page-numberページ番号1
--page-size1 ページあたりの項目数30

インテリジェント診断パラメーター(aliyun adbai):

パラメーター説明デフォルト値
--biz-region-idユーザーのクラスターのリージョン ID(製品に関する知識の Q&A ではデフォルト値 cn-beijing を使用し、ユーザーへの確認は不要です)条件付きで必須
--queryクエリ内容。インスタンス診断では "<db-cluster-id> <問題の説明>" の形式を使用し、知識に関する Q&A ではそのまま質問します(自然言語による時間の説明に対応しています)。必須
--regionサービスエンドポイントのリージョン(Skill が --biz-region-id に基づいて自動的にマッピングするため、ユーザーによる指定は不要です)自動
--endpointサービスエンドポイントのアドレス(Skill が --biz-region-id に基づいて自動的にマッピングするため、ユーザーによる指定は不要です)自動
--session-idセッション ID(複数ターンの会話では渡します)空(新しいセッション)
--timezoneタイムゾーン(例:Asia/Shanghai など)Asia/Shanghai
4.3 認証情報の設定

Alibaba Cloud API の認証情報は、このセッションの外部で aliyun configure を使って設定します。CLI が自動的に読み込みます。

認証情報のステータス確認:

aliyun configure list

出力の AccessKeyId 列が空、または <empty> と表示されている場合、認証情報は設定されていません。ユーザーに次の手順を案内してください。

  1. このセッションの外部でターミナルを開き、aliyun configure を実行して設定する
  2. または、シェルのプロファイルで環境変数を設定する
  3. 設定が完了したら戻り、処理を続行する

🔴 重要なルール:

  • セッション内で AK/SK 認証情報を入力するようユーザーに案内することは厳禁です
  • aliyun configure set --access-key-id など、認証情報を明示的に指定するパラメーターの使用は厳禁です
  • 認証情報の確認はタスクの最初の手順として必ず実施してください。失敗した場合は、その旨を報告して直ちに終了してください

AK、StsToken、RamRoleArn、EcsRamRole など、複数の認証情報タイプに対応しています。詳しくは認証情報の設定に関するドキュメントをご覧ください。

5. RAM ポリシー

この Skill に必要な RAM 権限の一覧については、references/ram-policies.md を参照してください。

[MUST] 権限エラーへの対処: 実行中にコマンドまたは API 呼び出しが権限エラーで失敗した場合は、次の手順に従ってください。

  1. references/ram-policies.md を読み、この Skill に必要な権限の一覧を確認します
  2. ram-permission-diagnose Skill を使用して、必要な権限を申請するようユーザーを案内します
  3. 必要な権限が付与されたことをユーザーが確認するまで待機します

6. パラメーターの確認

重要:パラメーターの確認 — コマンドまたは API 呼び出しを実行する前に、すべてのユーザー設定可能なパラメーター(biz-region-id、db-cluster-id、--query など)を必ずユーザーに確認してください。ユーザーの明示的な承認なしに、デフォルト値を推測して使用しないでください。

インタラクションモードの必須ルール:ユーザーの確認または選択が必要な手順(リージョン、クラスター、診断シナリオ、実行確認など)では、必ずオプションカードを使用してください。手動入力を求めることは禁止されています。具体的には、次のとおりです。

  • リージョンの確認 → オプションカード(選択肢は references/region-list.md を参照し、リージョン確認ルールはセクション 1.2 を参照) — 製品知識に関する Q&A では、この手順は不要です
  • クラスター ID の選択 → オプションカード(describe-db-clusters の結果から生成) — 製品知識に関する Q&A では、この手順は不要です
  • 診断シナリオの選択 → オプションカード(ユーザーの意図が明確でない場合は、利用可能な診断タイプを一覧表示)
  • 実行前の確認 → オプションカード(例:「続行」/「キャンセル」) — 製品知識に関する Q&A では、この手順は不要です。直接実行してください

7. ベストプラクティス

  1. CLI 優先:診断では CLI コマンドの使用を優先してください。クラスター管理には aliyun adb、インテリジェント診断には aliyun adbai を使用します
  2. コマンド出力:すべての API 呼び出しでは、応答の先頭にコマンド文字列全体を出力してください
  3. エラー処理:クラスター ID が存在しない場合は、ただ失敗させるのではなく、正しいクラスターを選択するようユーザーに案内してください
  4. 製品の境界:ADB MySQL クラスター(ID プレフィックスが am- または amv-)のみを扱い、他の製品の API と混在させないでください
  5. 選択肢を優先:ユーザーの確認または選択が必要な手順では、常にオプションカードを使用し、手動入力を求めないでください

8. 参照リンク

参照ファイル内容
references/ram-policies.mdRAM 権限リスト
references/verification-method.md検証方法
references/cli-installation-guide.mdAliyun CLI インストールガイド
references/region-list.mdAlibaba Cloud のリージョン ID 一覧
references/cluster-info.mdクラスター情報のクエリに関する詳細手順
references/cluster-diagnosis.mdクラスターのインテリジェント診断に関する詳細手順

コメント