Catalog Explorer 是 SAP Automation Pilot 体系下的一个探索类技能,核心作用是通过 API 动态发现租户中可用的命令与目录,为后续命令生成与执行提供依据。
【用途】 当需要了解 SAP Automation Pilot 环境中存在哪些执行器或命令、获取某个命令的定义细节,或需要基于已有命令组合出跨服务的复杂命令时,可使用本技能。文档给出的典型工作流是:用户提出“创建一个重启 CF 应用并检查 SM 绑定的命令”,先探索相关目录,再定位具体命令,然后获取定义以理解参数,最后生成复合命令。
【前置条件】 使用前必须设置以下环境变量:AUTOPI_HOSTNAME(示例为 emea.autopilot.cloud.sap)、AUTOPI_USERNAME、AUTOPI_PASSWORD。
【主要能力与使用方式】
- 列出全部目录:调用 GET /api/v1/catalogs,可返回 SAP 提供与自定义目录。
- 仅列出 SAP 内置目录:追加查询参数 provided=true。
- 仅列出自定义/租户目录:追加查询参数 own=true,也可使用 own=false。
- 列出某目录下的命令:GET /api/v1/commands?catalog=CATALOG,示例目录为 applm-sapcp。
- 获取命令定义:GET /api/v1/commands/COMMAND_ID,示例命令 ID 为 applm-sapcp:RestartCfApp:1。
- 跨目录搜索:先列出所有 SAP 提供目录的 ID,再对目标目录(如 applm-sapcp、sm-sapcp、cf-sapcp)循环调用命令列表接口,按关键词查找匹配命令。 所有调用均使用 curl 并结合 -u 参数传入用户名与密码进行基础认证。
【适用场景】 适用于需要先发现再编排的自动化运维场景,例如生成涉及多个服务的复合命令、查找可复用的内置执行器、核实命令 ID 与参数等。
【限制与错误处理】 文档列出三类常见问题:401 表示凭据无效,应检查环境变量;404 表示目录或命令不存在,应通过探索找到正确 ID;空响应表示目录内无命令,或该目录为空/受限。
【相关技能】 本技能与 automation-pilot-command-generation(使用本技能进行执行器发现)、automation-pilot-content-management-via-api(部署生成的命令)、automation-pilot-executions-api(运行与监控命令)配合使用。