基本格式

ctyun-cli <product> <action> [flags]

操作参数

每个操作的参数通过 --help 查看，使用 --参数名 值 的方式传入：

ctyun-cli vpc ListVpc --regionID bb9fdb42056f11eda1610242ac110002 --pageNumber 1 --pageSize 10
ctyun-cli vpc CreateVpc --clientToken "3dbb3c17-cbdc-465d-9e7b-64c936a211d3" --name "my-vpc" --CIDR "172.31.0.0/16" --regionID bb9fdb42056f11eda1610242ac110002

–body 参数

所有操作都支持 --body / -b 参数，直接传入 JSON 请求体。--body 中的字段优先级最高，会覆盖同名参数的值。

ctyun-cli vpc CreateVpc --body '{"clientToken":"3dbb3c17-cbdc-465d-9e7b-64c936a211d3","name":"my-vpc","CIDR":"172.31.0.0/16","regionID":"bb9fdb42056f11eda1610242ac110002"}'

适用场景：

• 参数较多时，直接传入 JSON 更方便

• 需要覆盖某个参数的值时

复杂类型参数

Object、Array 等复杂类型参数需要传入 JSON 字符串。复杂类型参数的子字段结构会在 --help 的 Complex Parameter 部分展示，包含每个子字段的名称、类型、是否必填和说明。

# Object 类型 — 传入 JSON 对象
ctyun-cli <product> <action> --<objectParam> '{"key1":"value1","key2":"value2"}'

# Array 类型 — 传入 JSON 数组
ctyun-cli <product> <action> --<arrayParam> '["value1","value2"]'

必填参数

必填参数在 --help 中标注为 (必填)。如果必填参数未通过 flag 或 --body 提供，CLI 会报错提示缺失的参数名。

# 缺少必填参数时的报错示例
错误: 必填参数未提供: regionID（可通过 flag 或 --body 传参）

查看帮助信息

CLI 支持的产品和操作在安装时已内置，可通过 --help 逐级浏览：

# 查看所有产品
ctyun-cli --help

# 查看某产品下的所有操作
ctyun-cli vpc --help

# 查看某操作的所有参数
ctyun-cli vpc ListVpc --help

帮助信息包含所有可用参数（必填参数标注 (必填)）、复杂类型参数的子字段结构及响应示例。