mcpField
A
alibabacloud-hologres-instance-manage

alibabacloud-hologres-instance-manage

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

alibabacloud-hologres-instance-manage について

Aliyun CLIを使って Alibaba Cloud Hologres のインスタンスを参照する読み取り専用スキルです。インスタンス一覧や詳細が必要な利用者向けに、認証情報とパラメーターの確認、RAM権限への対応を重視します。

主な機能

  1. 01Hologres インスタンスの一覧表示
  2. 02指定インスタンスの詳細取得
  3. 03リソースグループやタグによる絞り込み
  4. 04ステータス、仕様、エンドポイントの確認
  5. 05実行前の認証情報とパラメーター確認

活用シーン

  1. 01リージョン内の Hologres インスタンスの棚卸し
  2. 02ステータス、CPU、メモリ、ストレージの確認
  3. 03ネットワークエンドポイントと SSL 状態の確認
  4. 04リソースグループやタグで検索範囲を限定

インストール

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

$npx skills add https://github.com/aliyun/alibabacloud-aiops-skills --skill alibabacloud-hologres-instance-manage

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

同梱ファイル

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

references/
acceptance-criteria.md
cli-installation-guide.md
ram-policies.md
related-commands.md
verification-method.md

詳細

Hologres インスタンス管理

Alibaba Cloud Hologres インスタンスを管理するスキルです。すべてのインスタンスを一覧表示し、インスタンスの詳細を取得します。

アーキテクチャ

User → Aliyun CLI → Hologres API (hologram) → Instance List / Instance Details

インストール

事前確認: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 CLI プラグインの更新が必要です

[必須] aliyun configure set --auto-plugin-install true を実行して、プラグインの自動インストールを有効にしてください。 [必須] aliyun plugin update を実行して、既存のプラグインを常に最新の状態にしてください。

curl -fsSL --connect-timeout 4 --max-time 120 https://aliyuncli.alicdn.com/setup.sh | bash
aliyun version

[必須] CLI User-Agent — aliyun CLI のすべてのコマンド実行には、次を含める必要があります: --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage

認証

このスキルは Alibaba Cloud のデフォルト認証情報チェーンを使用します。AK/SK の値を読み取ったり、表示したり、明示的に扱ったりすることはありません。

セキュリティルール:

  • AK/SK の値を読み取ったり、エコーしたり、表示したりすることは絶対にしないでください
  • ユーザーに AK/SK を直接入力するよう求めることは絶対にしないでください
  • リテラルの認証情報を指定して aliyun configure set を使用することは絶対にしないでください
  • 認証情報の状態を確認するには、aliyun configure list のみを使用してください
aliyun configure list

有効なプロファイル(AK、STS、EcsRamRole、または RamRoleArn)があることを出力で確認してください。

有効なプロファイルがない場合は、ここで停止してください。 ユーザーはこのセッションの外で認証情報を設定し、aliyun configure list に有効なプロファイルが表示されてから戻る必要があります。

RAM ポリシー

このスキルには、次の RAM 権限が必要です。

製品RAM アクションリソース範囲説明
Hologramhologram:ListInstancesacs:hologram:{#regionId}:{#accountId}:instance/*すべての Hologres インスタンスを一覧表示
Hologramhologram:GetInstanceacs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}インスタンスの詳細を取得

完全な RAM ポリシーについては、references/ram-policies.md を参照してください。

[必須] 権限エラーへの対応: 実行中のいずれかの時点で、コマンドまたは API 呼び出しが権限エラーにより失敗した場合は、次の手順に従ってください。

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

パラメーターの確認

重要:パラメーターの確認 — コマンドまたは API 呼び出しを実行する前に、 ユーザーがカスタマイズ可能なすべてのパラメーター(例:RegionId、インスタンス名、リソースグループ ID、 タグなど)をユーザーに確認する必要があります。明示的な承認なしに、値を推測したりデフォルト値を使用したりしないでください。

パラメーター名必須/任意説明デフォルト値
RegionId任意インスタンスが配置されているリージョンユーザーのデフォルトリージョン
InstanceId必須(GetInstance の場合)Hologres インスタンスの IDなし
resourceGroupId任意リソースグループ ID で絞り込みなし
tag任意タグ(キーと値のペア)で絞り込みなし
cmsInstanceType任意Cloud Monitor インスタンスタイプ(standard/follower/mc-acceleration/warehouse/high-memory/serverless)なし

コアワークフロー

タスク 1:すべての Hologres インスタンスを一覧表示する

指定されたリージョンにあるすべての Hologres インスタンスを照会します。

# List all instances
aliyun hologram POST /api/v1/instances \
  --header "Content-Type=application/json" --body "{}" \
  --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage

# List instances with resource group filter
aliyun hologram POST /api/v1/instances \
  --header "Content-Type=application/json" \
  --body '{"resourceGroupId":"rg-acfmvscak73zmby"}' \
  --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage

# List instances with tag filter
aliyun hologram POST /api/v1/instances \
  --header "Content-Type=application/json" \
  --body '{"tag":[{"key":"env","value":"production"}]}' \
  --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage

# List instances by CMS instance type
aliyun hologram POST /api/v1/instances \
  --header "Content-Type=application/json" \
  --body '{"cmsInstanceType":"standard"}' \
  --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage

レスポンスフィールド:

  • InstanceId:インスタンス ID
  • InstanceName:インスタンス名
  • InstanceStatus:ステータス(Creating/Running/Suspended/Allocating)
  • InstanceType:タイプ(Warehouse/Follower/Standard/Serverless/Shared)
  • InstanceChargeType:支払いタイプ(PostPaid/PrePaid)
  • RegionId:リージョン ID
  • Endpoints:ネットワークエンドポイントの一覧
タスク 2:インスタンスの詳細情報を取得する

特定の Hologres インスタンスに関する詳細情報を取得します。

# Get instance details by ID
aliyun hologram GET /api/v1/instances/{instanceId} \
  --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage

# Example with actual instance ID
aliyun hologram GET /api/v1/instances/hgprecn-cn-i7m2v08uu00a \
  --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage

レスポンスフィールド:

  • InstanceId:インスタンス ID
  • InstanceName:インスタンス名(2~64 文字)
  • InstanceStatus:ステータス(Creating/Running/Suspended/Allocating)
  • InstanceType:タイプ(Warehouse/Follower/Standard/Serverless/Shared)
  • InstanceChargeType:支払いタイプ(PostPaid/PrePaid)
  • Cpu:CPU コア数
  • Memory:メモリ(GB)
  • Disk:標準ストレージ容量(GB)
  • ColdStorage:コールドストレージ容量(GB)
  • Version:インスタンスのバージョン
  • Endpoints:VPC/インターネット/イントラネットの詳細を含むネットワークエンドポイント
  • AutoRenewal:自動更新が有効かどうか
  • EnableHiveAccess:データレイクアクセラレーションが有効かどうか
  • EnableServerless:サーバーレスコンピューティングが有効かどうか
  • EnableSSL:SSL が有効かどうか
  • StorageType:ストレージタイプ(冗長/ローカル)

成功の確認方法

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

簡易確認
# Verify ListInstances
aliyun hologram POST /api/v1/instances \
  --header "Content-Type=application/json" --body "{}" \
  --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage | jq '.InstanceList'

# Verify GetInstance
aliyun hologram GET /api/v1/instances/{your-instance-id} \
  --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage | jq '.Instance.InstanceStatus'

成功を示す条件:

  • HTTP ステータスコードが 200
  • Success フィールドが true
  • InstanceList または Instance フィールドに有効なデータが含まれている

クリーンアップ

このスキルは読み取り専用の操作を行います。クリーンアップは不要です。

コマンド一覧

CLI コマンドの一覧については、references/related-commands.md を参照してください。

操作CLI コマンド説明
インスタンス一覧の取得aliyun hologram POST /api/v1/instances --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manageすべての Hologres インスタンスの一覧を取得します
インスタンスの取得aliyun hologram GET /api/v1/instances/{instanceId} --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage特定のインスタンスの詳細情報を取得します

ベストプラクティス

  1. コマンドを実行する前に、aliyun configure list を使用して必ず認証情報を確認してください
  2. 多数のインスタンスを一覧表示する場合は、フィルター(resourceGroupId、tags)を使用して結果を絞り込んでください
  3. 操作を行う前にインスタンスのステータスを確認してください。インスタンスが Running 状態であることを確認します
  4. 適切なネットワークエンドポイントを使用してください。内部アクセスには VPCSingleTunnel、外部アクセスには Internet を選択します
  5. インスタンスの有効期限を監視してください。サービスの中断を避けるため、PrePaid インスタンスの ExpirationTime を確認します
  6. 安全な接続を確保するため、本番環境ではSSL を有効にしてください

参考リンク

参考資料説明
references/cli-installation-guide.mdAliyun CLI のインストールガイド
references/ram-policies.md必要な RAM 権限
references/related-commands.mdCLI コマンドの一覧
references/verification-method.md成功の確認手順
Hologres API Documentation公式 API ドキュメント

エラー処理

HTTP ステータスエラーコードエラーメッセージ解決方法
403NoPermissionRAM ユーザーの権限が不足していますAliyunHologresReadOnlyAccess 権限を付与してください
400InvalidParameterパラメーター値が無効ですパラメーターの形式と制約を確認してください
404InstanceNotFoundインスタンスが存在しませんインスタンス ID が正しいことを確認してください

その他のエラーコードについては、Hologres Error Center を参照してください。

コメント