alibabacloud-hologres-instance-manage について
Aliyun CLIを使って Alibaba Cloud Hologres のインスタンスを参照する読み取り専用スキルです。インスタンス一覧や詳細が必要な利用者向けに、認証情報とパラメーターの確認、RAM権限への対応を重視します。
主な機能
- 01Hologres インスタンスの一覧表示
- 02指定インスタンスの詳細取得
- 03リソースグループやタグによる絞り込み
- 04ステータス、仕様、エンドポイントの確認
- 05実行前の認証情報とパラメーター確認
活用シーン
- 01リージョン内の Hologres インスタンスの棚卸し
- 02ステータス、CPU、メモリ、ストレージの確認
- 03ネットワークエンドポイントと SSL 状態の確認
- 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.mdcli-installation-guide.mdram-policies.mdrelated-commands.mdverification-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 アクション | リソース範囲 | 説明 |
|---|---|---|---|
| Hologram | hologram:ListInstances | acs:hologram:{#regionId}:{#accountId}:instance/* | すべての Hologres インスタンスを一覧表示 |
| Hologram | hologram:GetInstance | acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId} | インスタンスの詳細を取得 |
完全な RAM ポリシーについては、references/ram-policies.md を参照してください。
[必須] 権限エラーへの対応: 実行中のいずれかの時点で、コマンドまたは API 呼び出しが権限エラーにより失敗した場合は、次の手順に従ってください。
references/ram-policies.mdを読み、この SKILL に必要な権限の全リストを確認しますram-permission-diagnoseスキルを使用して、必要な権限の申請をユーザーに案内します- 必要な権限が付与されたことをユーザーが確認するまで待機します
パラメーターの確認
重要:パラメーターの確認 — コマンドまたは 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:インスタンス IDInstanceName:インスタンス名InstanceStatus:ステータス(Creating/Running/Suspended/Allocating)InstanceType:タイプ(Warehouse/Follower/Standard/Serverless/Shared)InstanceChargeType:支払いタイプ(PostPaid/PrePaid)RegionId:リージョン IDEndpoints:ネットワークエンドポイントの一覧
タスク 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:インスタンス IDInstanceName:インスタンス名(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フィールドがtrueInstanceListまたは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 | 特定のインスタンスの詳細情報を取得します |
ベストプラクティス
- コマンドを実行する前に、
aliyun configure listを使用して必ず認証情報を確認してください - 多数のインスタンスを一覧表示する場合は、フィルター(resourceGroupId、tags)を使用して結果を絞り込んでください
- 操作を行う前にインスタンスのステータスを確認してください。インスタンスが
Running状態であることを確認します - 適切なネットワークエンドポイントを使用してください。内部アクセスには VPCSingleTunnel、外部アクセスには Internet を選択します
- インスタンスの有効期限を監視してください。サービスの中断を避けるため、PrePaid インスタンスの
ExpirationTimeを確認します - 安全な接続を確保するため、本番環境ではSSL を有効にしてください
参考リンク
| 参考資料 | 説明 |
|---|---|
| references/cli-installation-guide.md | Aliyun CLI のインストールガイド |
| references/ram-policies.md | 必要な RAM 権限 |
| references/related-commands.md | CLI コマンドの一覧 |
| references/verification-method.md | 成功の確認手順 |
| Hologres API Documentation | 公式 API ドキュメント |
エラー処理
| HTTP ステータス | エラーコード | エラーメッセージ | 解決方法 |
|---|---|---|---|
| 403 | NoPermission | RAM ユーザーの権限が不足しています | AliyunHologresReadOnlyAccess 権限を付与してください |
| 400 | InvalidParameter | パラメーター値が無効です | パラメーターの形式と制約を確認してください |
| 404 | InstanceNotFound | インスタンスが存在しません | インスタンス ID が正しいことを確認してください |
その他のエラーコードについては、Hologres Error Center を参照してください。