Hologres Instance Management
Skill for managing Alibaba Cloud Hologres instances - list all instances and get instance details.
Architecture
CODEBLOCK0
Installation
Pre-check: Aliyun CLI >= 3.3.1 required
Run aliyun version to verify >= 3.3.1. If not installed or version too low,
see references/cli-installation-guide.md for installation instructions.
Then [MUST] run aliyun configure set --auto-plugin-install true to enable automatic plugin installation.
CODEBLOCK1
Authentication
This skill relies on the Alibaba Cloud default credential chain. It never reads, prints, or explicitly handles AK/SK values.
Security Rules:
- - NEVER read, echo, or print AK/SK values
- NEVER ask the user to input AK/SK directly
- NEVER use
aliyun configure set with literal credential values - ONLY use
aliyun configure list to verify credential status
CODEBLOCK2
Check the output for a valid profile (AK, STS, EcsRamRole, or RamRoleArn).
If no valid profile exists, STOP here. The user must configure credentials outside of this session and return after aliyun configure list shows a valid profile.
RAM Policy
The following RAM permissions are required for this skill:
| Product | RAM Action | Resource Scope | Description |
|---|
| Hologram | hologram:ListInstances | INLINECODE6 | List all Hologres instances |
| Hologram |
hologram:GetInstance |
acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId} | Get instance details |
See references/ram-policies.md for the complete RAM policy document.
[MUST] Permission Failure Handling: When any command or API call fails due to permission errors at any point during execution, follow this process:
- 1. Read
references/ram-policies.md to get the full list of permissions required by this SKILL - Use
ram-permission-diagnose skill to guide the user through requesting the necessary permissions - Pause and wait until the user confirms that the required permissions have been granted
Parameter Confirmation
IMPORTANT: Parameter Confirmation — Before executing any command or API call,
ALL user-customizable parameters (e.g., RegionId, instance names, resource group IDs,
tags, etc.) MUST be confirmed with the user. Do NOT assume or use default values without explicit user approval.
| Parameter Name | Required/Optional | Description | Default Value |
|---|
| RegionId | Optional | Region where instances are located | User's default region |
| InstanceId |
Required (for GetInstance) | The ID of the Hologres instance | None |
| resourceGroupId | Optional | Filter by resource group ID | None |
| tag | Optional | Filter by tags (key-value pairs) | None |
| cmsInstanceType | Optional | Cloud Monitor instance type (standard/follower/mc-acceleration/warehouse/high-memory/serverless) | None |
Core Workflow
Task 1: List All Hologres Instances
Query all Hologres instances in the specified region.
CODEBLOCK3
Response Fields:
- -
InstanceId: Instance ID - INLINECODE11 : Instance name
- INLINECODE12 : Status (Creating/Running/Suspended/Allocating)
- INLINECODE13 : Type (Warehouse/Follower/Standard/Serverless/Shared)
- INLINECODE14 : Payment type (PostPaid/PrePaid)
- INLINECODE15 : Region ID
- INLINECODE16 : Network endpoints list
Task 2: Get Instance Details
Get detailed information about a specific Hologres instance.
CODEBLOCK4
Response Fields:
- -
InstanceId: Instance ID - INLINECODE18 : Instance name (2-64 characters)
- INLINECODE19 : Status (Creating/Running/Suspended/Allocating)
- INLINECODE20 : Type (Warehouse/Follower/Standard/Serverless/Shared)
- INLINECODE21 : Payment type (PostPaid/PrePaid)
- INLINECODE22 : CPU cores
- INLINECODE23 : Memory in GB
- INLINECODE24 : Standard storage size in GB
- INLINECODE25 : Cold storage capacity in GB
- INLINECODE26 : Instance version
- INLINECODE27 : Network endpoints with VPC/Internet/Intranet details
- INLINECODE28 : Whether auto-renewal is enabled
- INLINECODE29 : Whether data lake acceleration is enabled
- INLINECODE30 : Whether serverless computing is enabled
- INLINECODE31 : Whether SSL is enabled
- INLINECODE32 : Storage type (redundant/local)
Success Verification Method
See references/verification-method.md for detailed verification steps.
Quick Verification
CODEBLOCK5
Success Indicators:
- - HTTP status code 200
- INLINECODE33 field is INLINECODE34
- INLINECODE35 or
Instance field contains valid data
Cleanup
This skill performs read-only operations. No cleanup is required.
Command Tables
See references/related-commands.md for the complete CLI commands reference.
| Action | CLI Command | Description |
|---|
| List Instances | INLINECODE37 | Get list of all Hologres instances |
| Get Instance |
aliyun hologram GET /api/v1/instances/{instanceId} --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills | Get details of a specific instance |
Best Practices
- 1. Always verify credentials before executing commands using INLINECODE39
- Use filters (resourceGroupId, tags) to narrow down results when listing many instances
- Check instance status before performing operations - ensure instance is in
Running state - Use appropriate network endpoints - choose VPCSingleTunnel for internal access, Internet for external access
- Monitor instance expiration - check
ExpirationTime for PrePaid instances to avoid service interruption - Enable SSL for production environments to ensure secure connections
Reference Links
Required RAM permissions |
|
references/related-commands.md | Complete CLI commands reference |
|
references/verification-method.md | Success verification steps |
|
Hologres API Documentation | Official API documentation |
Error Handling
| HTTP Status | Error Code | Error Message | Resolution |
|---|
| 403 | NoPermission | RAM user permission is insufficient | Grant AliyunHologresReadOnlyAccess permission |
| 400 |
InvalidParameter | Invalid parameter value | Check parameter format and constraints |
| 404 | InstanceNotFound | Instance does not exist | Verify instance ID is correct |
For more error codes, see Hologres Error Center.
Hologres 实例管理
用于管理阿里云Hologres实例的技能——列出所有实例并获取实例详情。
架构
用户 → Aliyun CLI → Hologres API (hologram) → 实例列表 / 实例详情
安装
前置检查：需要 Aliyun CLI >= 3.3.1
运行 aliyun version 确认版本 >= 3.3.1。如果未安装或版本过低，
请参阅 references/cli-installation-guide.md 获取安装说明。
然后[必须]运行 aliyun configure set --auto-plugin-install true 启用自动插件安装。
bash
curl -fsSL --connect-timeout 4 --max-time 120 https://aliyuncli.alicdn.com/install.sh | bash
aliyun version
身份认证
本技能依赖阿里云默认凭证链。它从不读取、打印或显式处理AK/SK值。
安全规则：
- - 绝不读取、回显或打印AK/SK值
- 绝不要求用户直接输入AK/SK
- 绝不使用字面凭证值执行 aliyun configure set
- 仅使用 aliyun configure list 验证凭证状态
bash
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调用在执行过程中因权限错误失败时，请遵循以下流程：
- 1. 读取 references/ram-policies.md 获取本技能所需的完整权限列表
- 使用 ram-permission-diagnose 技能引导用户申请必要权限
- 暂停并等待用户确认所需权限已授予
参数确认
重要：参数确认 — 在执行任何命令或API调用之前，
所有用户可自定义的参数（例如：RegionId、实例名称、资源组ID、
标签等）必须与用户确认。未经用户明确批准，不得假设或使用默认值。
| 参数名称 | 必填/可选 | 描述 | 默认值 |
|---|
| RegionId | 可选 | 实例所在区域 | 用户的默认区域 |
| InstanceId |
必填（用于GetInstance） | Hologres实例的ID | 无 |
| resourceGroupId | 可选 | 按资源组ID筛选 | 无 |
| tag | 可选 | 按标签筛选（键值对） | 无 |
| cmsInstanceType | 可选 | 云监控实例类型（standard/follower/mc-acceleration/warehouse/high-memory/serverless） | 无 |
核心工作流
任务1：列出所有Hologres实例
查询指定区域内的所有Hologres实例。
bash
列出所有实例
aliyun hologram POST /api/v1/instances \
--header Content-Type=application/json --body {} \
--read-timeout 4 --user-agent AlibabaCloud-Agent-Skills
按资源组筛选列出实例
aliyun hologram POST /api/v1/instances \
--header Content-Type=application/json \
--body {resourceGroupId:rg-acfmvscak73zmby} \
--read-timeout 4 --user-agent AlibabaCloud-Agent-Skills
按标签筛选列出实例
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
按CMS实例类型列出实例
aliyun hologram POST /api/v1/instances \
--header Content-Type=application/json \
--body {cmsInstanceType:standard} \
--read-timeout 4 --user-agent AlibabaCloud-Agent-Skills
响应字段：
- - InstanceId：实例ID
- InstanceName：实例名称
- InstanceStatus：状态（Creating/Running/Suspended/Allocating）
- InstanceType：类型（Warehouse/Follower/Standard/Serverless/Shared）
- InstanceChargeType：付费类型（PostPaid/PrePaid）
- RegionId：区域ID
- Endpoints：网络端点列表
任务2：获取实例详情
获取特定Hologres实例的详细信息。
bash
按ID获取实例详情
aliyun hologram GET /api/v1/instances/{instanceId} \
--read-timeout 4 --user-agent AlibabaCloud-Agent-Skills
使用实际实例ID的示例
aliyun hologram GET /api/v1/instances/hgprecn-cn-i7m2v08uu00a \
--read-timeout 4 --user-agent AlibabaCloud-Agent-Skills
响应字段：
- - 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/Internet/Intranet详情的网络端点
- AutoRenewal：是否启用自动续费
- EnableHiveAccess：是否启用数据湖加速
- EnableServerless：是否启用Serverless计算
- EnableSSL：是否启用SSL
- StorageType：存储类型（redundant/local）
成功验证方法
详细验证步骤请参见 references/verification-method.md。
快速验证
bash
验证ListInstances
aliyun hologram POST /api/v1/instances \
--header Content-Type=application/json --body {} \
--read-timeout 4 --user-agent AlibabaCloud-Agent-Skills | jq .InstanceList
验证GetInstance
aliyun hologram GET /api/v1/instances/{your-instance-id} \
--read-timeout 4 --user-agent AlibabaCloud-Agent-Skills | 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 | 获取所有Hologres实例列表 |
| 获取实例 |
aliyun hologram GET /api/v1/instances/{instanceId} --read-timeout 4 --user-agent AlibabaCloud-Agent-Skills | 获取特定实例的详情 |
最佳实践
- 1. 始终在执行命令前使用 aliyun configure list 验证凭证
- 使用筛选条件（resourceGroupId、tags）在列出大量实例时缩小结果范围
- 在执行操作前检查实例状态 — 确保实例处于Running状态
- 使用合适的网络端点 — 内部访问选择VPCSingleTunnel，外部访问选择Internet
- 监控实例过期时间 — 检查PrePaid实例的ExpirationTime以避免服务中断
- 在生产环境中启用SSL以确保安全连接
参考链接
| 参考 | 描述 |
|-----------|-------------|
| [references/cli-installation
