SuperAPI AI 工具集

btp-cli

部署与运维

查看项目

更新于 11-03 16:15

技能介绍

SAP BTP CLI 助手专注于 SAP Business Technology Platform 命令行接口(btp CLI),帮助用户构造正确的命令、自动化多步骤 BTP 工作流并排查问题。其目标是提供精确、可运行的命令及正确的标志和参数值,减少用户反复查阅 btp --help 的需要。

命令语法:每个 btp 命令遵循 btp [OPTIONS] ACTION GROUP/OBJECT [PARAMS] 结构。OPTIONS 位于动作之前,全局修改行为,例如 --format json 输出机器可读结果(强烈推荐用于脚本),--verbose 输出详细调试信息。ACTION 是动词,可用动作包括 get、list、create、update、delete、add、remove、assign、unassign、enable、move、register、unregister、subscribe、unsubscribe、share、unshare。GROUP/OBJECT 标识操作对象,分为 accounts(全局账户、子账户、目录、权限、区域、环境实例、订阅、资源提供者)、security(用户、角色集合、角色、信任配置、身份提供者)、services(服务实例、绑定、代理、计划、产品、平台)。PARAMS 跟在组/对象之后,第一个参数可以是位置参数,其余使用 --key value 语法;若值以连字符开头,需使用等号形式如 --user="-someone"。

通用命令(无组/对象)包括 btp login(登录全局账户)、btp logout、btp target(设置后续命令默认子账户/目录)、btp help(查看帮助)、btp set config(修改持久配置)、btp feedback(发送反馈)。

认证:推荐 SSO 登录 btp login --sso,打开浏览器进行身份提供者认证;SAP Universal ID 用户必须使用 SSO。自定义身份提供者可加 --idp <TENANT_ID>,租户 ID 可通过 btp list security/trust 或驾驶舱的 Security > Trust Configuration 查找。无头或远程环境可使用 btp login --sso manual 手动打开 URL。基本登录使用 btp login --url https://cli.btp.cloud.sap --subdomain <GLOBAL_ACCOUNT_SUBDOMAIN>。登录参数包括 --sso、--idp、--url、--subdomain、--user、--password(启用 MFA 时附加 2FA 令牌)。会话最长持续 12 小时,配置存储在 macOS 的 ~/Library/Application Support/.btp/config.json、Linux 的 ~/.config/.btp/config.json、Windows 的 %APPDATA%\SAP\btp\config.json。若同一邮箱关联多个账户,建议使用 S-user 或 P-user ID。

目标设定:默认命令针对全局账户。使用 btp target --subaccount <SUBACCOUNT_ID> 或 btp target --directory <DIRECTORY_ID> 将命令范围限定到子账户或目录,避免每次传递 --subaccount 或 --directory;btp target 不带参数可清除目标回到全局账户。服务和安全命令几乎总是需要子账户上下文,因此目标设定尤为重要。

命令参考按组划分:accounts 组涵盖全局账户查询(含 --show-hierarchy 显示完整组织树)、子账户的列表/获取/创建/更新/删除、目录管理、权限列表与分配、可用区域列表、环境实例(Cloud Foundry、Kyma 等)的列表/创建/获取/删除、订阅的列表/订阅/取消订阅。security 组涵盖角色集合的列表/获取/创建/分配/取消分配、用户的列表/获取/删除、角色列表与获取、信任配置列表与获取。services 组涵盖服务产品和计划列表与获取、服务实例的列表/获取/创建/更新/删除/共享/取消共享、服务绑定的列表/获取/创建/删除、服务代理的列表/获取/注册/更新/注销。运行服务命令前应先执行 btp target --subaccount <ID>。

脚本与自动化:文本输出面向人类且可能随版本变化,脚本中应使用 --format json(可为单条命令指定或通过 btp set config --format json 设为默认)。JSON 响应包含比文本输出更多的字段(GUID、时间戳、状态信息),且跨 CLI 版本稳定。可结合 jq 进行单行处理,例如按显示名称获取子账户 ID:btp --format json list accounts/subaccount | jq -r '.value[] | select(.displayName=="Dev") | .guid';列出所有已授权服务名称:btp --format json list accounts/entitlement | jq -r '.entitledServices[].name';从环境实例获取 CF API 端点等。常见脚本模式包括将 ID 存入变量、条件判断(创建前检查子账户是否存在)、遍历结果(为所有子账户分配权限)。配置选项包括 btp set config --format json 和 btp set config --target.hierarchy true。

常见工作流:完整子账户端到端设置包括登录、检查区域、创建子账户、目标设定、分配权限、创建 CF 环境、分配管理员角色,最后切换到 cf CLI 创建空间。授予用户访问权限需先目标设定子账户,再分配角色集合。创建服务实例和绑定需先目标设定子账户,创建实例后创建绑定,并通过获取绑定查看凭据。

故障排查:登录失败可能因服务器 URL 或子域名错误、未指定自定义 IdP、会话过期(最长 12 小时)或邮箱解析到错误账户;修复方法包括验证 URL 和子域名、添加 --idp、重新登录、使用 S-user 或 P-user ID。命令失败可能因未目标设定子账户导致服务命令“未找到”、缺少角色集合导致“权限不足”、全局账户配额耗尽导致权限分配失败、连字符前缀值语法错误(应使用等号)。通用调试可添加 --verbose 查看请求/响应详情,检查 JSON 输出中的错误信息,运行 btp help <ACTION> <GROUP/OBJECT> 获取准确参数名称和类型,并确认可访问 https://cli.btp.cloud.sap。

生成命令的建议:当用户用自然语言描述需求时,先识别动作(创建、列出、分配、删除等),再识别组/对象(账户、安全或服务),检查是否需要目标设定(服务和安全命令几乎总需要子账户目标),填充参数(向用户询问缺失的 ID、名称或值,不要猜测 GUID),若用户编写脚本或需要提取特定值则建议使用 JSON 输出。提供命令时应给出完整可运行的示例而非片段;若缺少某个值(如子账户 ID),使用清晰的占位符如 <SUBACCOUNT_ID> 并告知用户如何查找(例如运行 btp list accounts/subaccount 获取 ID)。