Hologres 实例管理

用于管理阿里云 Hologres 实例的 Skill——列出所有实例并获取实例详情。

架构

用户 → Aliyun CLI → Hologres API(hologram)→ 实例列表 / 实例详情

安装

预检查:需要 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

认证

本 Skill 依赖阿里云默认凭证链。它绝不读取、打印或显式处理 AK/SK 值。

安全规则:
- 绝不读取、回显或打印 AK/SK 值
- 绝不要求用户直接输入 AK/SK
- 绝不使用带有明文凭证值的 aliyun configure set
- 只能使用 aliyun configure list 验证凭证状态
aliyun configure list

检查输出中是否存在有效 profile(AK、STS、EcsRamRole 或 RamRoleArn)。

如果不存在有效 profile,请在此停止。 用户必须在本会话之外配置凭证,并在 aliyun configure list 显示有效 profile 后返回。

RAM 策略

本 Skill 需要以下 RAM 权限:

产品RAM Action资源范围说明
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 skill 引导用户申请必要权限
3. 暂停并等待用户确认所需权限已授予

参数确认

重要:参数确认 —— 在执行任何命令或 API 调用之前,
所有用户可自定义参数(例如 RegionId、实例名、资源组 ID、
标签等)都必须与用户确认。未经用户明确批准,不要假设或使用默认值。
参数名必填/可选说明默认值
RegionId可选实例所在地域用户默认地域
InstanceId必填(GetInstance)Hologres 实例 ID
resourceGroupId可选按资源组 ID 过滤
tag可选按标签过滤(键值对)
cmsInstanceType可选云监控实例类型(standard/follower/mc-acceleration/warehouse/high-memory/serverless)

核心工作流

任务 1:列出所有 Hologres 实例

查询指定地域中的所有 Hologres 实例。

列出所有实例

aliyun hologram POST /api/v1/instances \

--header "Content-Type=application/json" --body "{}" \

--read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage

带资源组过滤列出实例

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

带标签过滤列出实例

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

按 CMS 实例类型列出实例

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`:网络 endpoint 列表

### 任务 2:获取实例详情

获取特定 Hologres 实例的详细信息。

按 ID 获取实例详情

aliyun hologram GET /api/v1/instances/{instanceId} \

--read-timeout 4 --user-agent AlibabaCloud-Agent-Skills/alibabacloud-hologres-instance-manage

带实际实例 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`:网络 endpoint,含 VPC/Internet/Intranet 详情
- `AutoRenewal`:是否启用自动续费
- `EnableHiveAccess`:是否启用数据湖加速
- `EnableServerless`:是否启用 serverless 计算
- `EnableSSL`:是否启用 SSL
- `StorageType`:存储类型(redundant/local)

成功验证方法

详细验证步骤见 references/verification-method.md

快速验证

验证 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'

验证 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` 字段包含有效数据

清理

本 Skill 执行只读操作。无需清理。

命令表

完整 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. 使用适当的网络 endpoint——内部访问选择 VPCSingleTunnel,外部访问选择 Internet
  5. 监控实例到期——对 PrePaid 实例检查 ExpirationTime 以避免服务中断
  6. 生产环境启用 SSL 以确保安全连接

参考链接

参考说明
references/cli-installation-guide.mdAliyun CLI 安装指南
references/ram-policies.md所需 RAM 权限
references/related-commands.md完整 CLI 命令参考
references/verification-method.md成功验证步骤
Hologres API 文档官方 API 文档

错误处理

HTTP 状态错误码错误消息解决
403NoPermissionRAM 用户权限不足授予 AliyunHologresReadOnlyAccess 权限
400InvalidParameter无效参数值检查参数格式和约束
404InstanceNotFound实例不存在验证实例 ID 正确

更多错误码见 Hologres 错误中心

文档 5 / 6:alibabacloud-yike-storyboard