天翼混合云OpenAPI CLI命令行工具

天翼混合云OpenAPI命令行工具（ctyun-hybrid-cli）是一个用于访问天翼混合云服务的命令行接口工具，支持ECS、EBS、VPC、NAT、ELB等多种云资源管理。cli 工具实在天翼混合云golang SDK 基础上面开发的，如您使用过程中遇到问题，可以联系天翼混合云产品经理或者混合云PMO获取技术支持。

环境要求

Go 1.19 或更高版本

Linux/macOS/Windows 操作系统

安装

从源码编译

验证安装

使用编译好的文件

默认在项目的bin 目录下生成了编译好的文件，可以直接使用，格式为 ctyun-hybrid-cli-<os>-<arch> windows 得默认携带了.exe的文件后缀

快速开始

1. 初始化配置

首次使用前，必须先配置连接信息：

参数说明：

--access-key: 访问混合云OpenAPI的AK（Access Key）

--secret-access-key: 访问混合云OpenAPI的SK（Secret Key）

--endpoint-ip: 网关服务的IP地址或主机名

--endpoint-port: 网关服务端口，默认为12320

--domain-suffix: 域名后缀，默认为ctyun.local，可以不设置

--scheme: 请求协议，默认为http

--timeout: 请求超时时间（秒），默认为60

Access Key 和 Secret Key 需要您从混合云管控制台获取，登录云管后右上角个人中心，进入后点击左侧菜单我的凭证 ，其中 访问密钥ID 为Access Key， 访问密钥 为Secret Key

网关IP地址和端口号联系混合云运维同学支持，默认IP为云管页面访问的ip 端口号为12320，默认使用http请求进行方法，当前版本的cli工具不支持私有证书签名的https 访问。

配置文件默认生成在当前目录下 conf/config内

2. 查看配置

3. 调用API

配置完成后，即可调用各种OpenAPI：

注意默认所有的api都支持--json-params 或者--json-file 模式，GET查询接口支持命令行参数模式赋值

4. 自动提示

当前cli支持配置命令行提示参考kubecli能力使用方法

具体其他命令行环境支持情况，请执行如下命令查看

5. 查看命令行帮忙信息

具体调用那个api 说明可以使用，如下命令查找

配置说明

配置文件位置

配置文件按照以下优先级顺序搜索：

/etc/ctyun-hybrid-cli/config

$workspaceFolder./conf/config

$HOME/.ctyun-hybrid-cli/config

./conf/config

当前目录下的 config 文件

配置文件格式

配置文件采用YAML格式，示例：

环境变量

支持通过环境变量配置认证信息：

SERVER_AK: Access Key

SERVER_SK: Secret Key

使用示例

基本用法格式

使用JSON字符串传参

使用JSON文件传参

创建一个JSON文件 params.json：

{
  "regionID": "nm8",
  "flavorUUID": "xxx-xxx-xxx",
  "imageID": "xxx-xxx-xxx",
  "vmName": "my-instance"
}

然后使用：

ROA风格API调用

支持直接使用HTTP方法调用API：

调试模式

启用调试输出：

在命令行

支持的服务

服务代码	服务名称	描述
`ctecs`	云主机ECS	弹性云服务器管理
`ebs`	云硬盘EBS	弹性块存储管理
`ebm`	裸金属	裸金属管理
`ctvpc`	虚拟私有云VPC	网络VPC管理
`ctnat`	NAT网关	NAT网关管理
`ctelb`	负载均衡ELB	弹性负载均衡管理
`eip`	弹性公网IP	EIP管理
`ctimage`	镜像服务	镜像管理
`sfs`	文件存储SFS	文件存储SFS
`oceanfs`	海量存储OceanFS	海量存储OceanFS
`iam`	身份认证IAM	访问控制管理
`monitor`	监控服务	监控数据查询
`audit`	审计服务	审计日志查询
`billing`	计费服务	账单查询
`order`	订单服务	订单管理
`common`	通用服务	公共API接口
`user`	用户管理	用户管理
`audit`	混合云管审计日志服务	混合云管审计日志服务
`cda`	专线网关、SDWAN服务	专线网关、SDWAN服务
`ctdec`	计算专属私有云	计算专属私有云
`cthpc`	宿主机集群管理	宿主机集群管理
`cthpc`	宿主机集群管理	宿主机集群管理
`ctmessage`	云管消息服务	云管消息服务
`ctvpn`	私网vpn管理	私网vpn管理
`ebsbackup`	块存储备份	块存储备份
`ebsbackup`	块存储备份	块存储备份
`hpfs`	并行文件存储	并行文件存储
`scaling`	云主机弹性伸缩管理	云主机弹性伸缩管理
`zos`	对象存储	对象存储

常用命令

查看API列表

查看某个服务支持的所有API：

显示信息如下：

可以使用grep 搜索相关的关键词，或者使用api路径进行搜索

云主机操作

云硬盘操作

网络

通用操作

输出格式

命令执行成功后，返回格式如下：

HttpStatusCode:	200 #http响应状态码
RequestId:     	1722ccb3-1851-479e-ad25-cd75ad5709ce #当前请求使用的requestId
ResponseBody:   # 响应body 信息
               	{
               		"currentCount": 1,
               		"description": "成功",
               		"errorCode": "SUCCESS",
               		"message": "success",
               		"returnObj": {
               			"vpcs": [
               				{
               					"CIDR": "192.168.0.0/16",
               					"name": "vpc-zsy-yg07",
               					"subnetIDs": [
               						"b3a2416f-8c6f-4be7-89f5-6ba8447703db"
               					],
               					"vpcID": "9af9954e-7fdc-471e-99da-ccd2446c8298",
               					"projectID": "8c39262f-d5de-4bcc-9cfc-147c58f0c20f"
               				}
               			]
               		},
               		"statusCode": 800,
               		"totalCount": 1017,
               		"totalPage": 1017
               	}

故障排查

配置文件未找到

错误信息: WARN: config file not found please use ctyun-hybrid-cli config <opts> config

解决方法: 首先执行 config set 命令初始化配置

认证失败

错误信息: ERROR: Authentication failed

解决方法: 检查AK/SK是否正确，确认配置文件中的认证信息

网络连接问题

错误信息: ERROR: dial tcp: lookup xxx on xxx:53: no such host

解决方法:

检查 --endpoint-ip 是否正确

检查网络连接是否正常

确认防火墙规则

API调用失败

错误信息: ERROR: do xxx with error xxx

解决方法:

使用 --debug 参数查看详细日志

检查JSON参数格式是否正确

确认API路径和参数名称

天翼混合云云管OpenAPI Cli工具使用文档

天翼混合云OpenAPI CLI命令行工具#

目录#

环境要求#

安装#

从源码编译#

验证安装#

使用编译好的文件#

快速开始#

1. 初始化配置#

2. 查看配置#

3. 调用API#

4. 自动提示#

5. 查看命令行帮忙信息#

配置说明#

配置文件位置#

配置文件格式#

环境变量#

使用示例#

基本用法格式#

使用JSON字符串传参#

使用JSON文件传参#

ROA风格API调用#

调试模式#

支持的服务#

常用命令#

查看API列表#

云主机操作#

云硬盘操作#

网络#

通用操作#

输出格式#

故障排查#

配置文件未找到#

认证失败#

网络连接问题#

API调用失败#