SuperAPI AI 工具集

bk-cli-sops

部署与运维

查看项目

更新于 10-16 08:26

技能介绍

bk-cli sops 是 bk-cli 中用于调用蓝鲸标准运维(SOPS)API 的系统子命令。它适合需要通过命令行查询流程模板、创建和管理运维任务的场景。

使用前提 开始前必须先用 Read 工具读取 ../bk-cli-shared/SKILL.md。该共享 skill 负责认证、context、tenant、stage、dry-run、verbose、header/body 和通用请求规则;本 skill 只补充 sops 命令自己的语义与输入约定。

当前覆盖的命令 本 skill 当前覆盖以下常用命令:get_template_list、get_task_list、get_task_status、get_task_detail、create_task、start_task、operate_task。

模板查询 get_template_list 用于查询流程模板。示例:

bk-cli sops get_template_list --bk_biz_id 2 bk-cli sops get_template_list --bk_biz_id 2 --keyword deploy

调用路径:GET /get_template_list/{bk_biz_id}/。

任务管理 get_task_list 用于查询任务列表。示例:

bk-cli sops get_task_list --bk_biz_id 2 bk-cli sops get_task_list --bk_biz_id 2 --keyword deploy --limit 50

调用路径:GET /get_task_list/{bk_biz_id}/。

create_task 用于从模板创建任务。示例:

bk-cli sops create_task --bk_biz_id 2 --template_id 100 --name "deploy-v1" bk-cli sops create_task --bk_biz_id 2 --template_id 100 --name "deploy" --constants '{"${key}":"value"}'

说明:--constants 必须是 JSON 对象,CLI 会以嵌套对象形式写入请求体。调用路径:POST /create_task/{template_id}/{bk_biz_id}/。

start_task 用于启动已创建的任务。示例:

bk-cli sops start_task --bk_biz_id 2 --task_id 100

调用路径:POST /start_task/{task_id}/{bk_biz_id}/。

get_task_status 用于查询任务状态。示例:

bk-cli sops get_task_status --task_id 100 --bk_biz_id 2

调用路径:GET /get_task_status/{task_id}/{bk_biz_id}/。

get_task_detail 用于查询任务详情。示例:

bk-cli sops get_task_detail --task_id 100 --bk_biz_id 2

调用路径:GET /get_task_detail/{task_id}/{bk_biz_id}/。

operate_task 用于操作任务,支持暂停、继续或终止。示例:

bk-cli sops operate_task --bk_biz_id 2 --task_id 100 --action pause bk-cli sops operate_task --bk_biz_id 2 --task_id 100 --action resume bk-cli sops operate_task --bk_biz_id 2 --task_id 100 --action revoke

说明:action 必须是 pause / resume / revoke 之一。调用路径:POST /operate_task/{task_id}/{bk_biz_id}/。

适用场景 需要在命令行中查询蓝鲸标准运维的流程模板、查看任务列表与状态、从模板创建任务、启动任务,或对任务执行暂停、继续、终止等操作时适用。

限制 本 skill 仅覆盖上述列出的命令;其他命令及更详细信息暂未提供。使用前必须先读取共享 skill 文件以获取认证与通用请求规则。