zstack-cli是供管理员调用所有ZStack API的命令行工具。本手册中所有API示例都将用zstack-cli来展示。
ZStack基于SOA（Service Oriented Architecture，面向服务架构）而设计，所有的ZStack操作本质上都是消息。例如，启动云主机的StartVmInstanceCLI命令，可以映射到APIStartVmInstanceMsg的API消息。
ZStack包含了内置的HTTP服务，将所有API消息封装于HTTP POST请求中，zstack-cli是基于内置的HTTP服务调用API请求进行相应的业务处理。
[root@localhost ~]# zstack-cli ZStack command line tool Type "help" for more information Type Tab key for auto-completion Type "quit" or "exit" or Ctrl-d to exit[root@localhost ~]# zstack-cli --help Usage: -c [options] Options: -h, --help show this help message and exit -H HOST, --host=HOST [Optional] IP address or DNS name of a ZStack management node. Default value: localhost -p PORT, --port=PORT [Optional] Port that the ZStack management node is listening on. Default value: 8080 -d DEPLOY_CONFIG_FILE, --deploy=DEPLOY_CONFIG_FILE [Optional] deploy a cloud from a XML file. -t DEPLOY_CONFIG_TEMPLATE_FILE, --template=DEPLOY_CONFIG_TEMPLATE_FILE [Optional] variable template file for XML file specified in option '-d' -D ZSTACK_CONFIG_DUMP_FILE, --dump=ZSTACK_CONFIG_DUMP_FILE [Optional] dump a cloud to a XML file -P ADMIN_PASSWORD, --password=ADMIN_PASSWORD [Optional] admin account password for dumping and recovering cloud environment. It can only be used when set -D or -d option. Default is 'password'. -s, --no-secure [Optional] if setting -s, will save password information in command history. [root@localhost ~]# zstack-cli -H 172.20.16.35 ZStack command line tool Type "help" for more information Type Tab key for auto-completion Type "quit" or "exit" or Ctrl-d to exit admin >>>如果有多个管理节点, 可以通过zstack-cli连接到任一个管理节点。
[root@localhost ~]# zstack-cli -H 172.20.16.35 QueryZone name=Zone-1 { "inventories": [ { "createDate": "Nov 17, 2017 8:27:47 PM", "lastOpDate": "Nov 17, 2017 8:27:47 PM", "name": "Zone-1", "state": "Enabled", "type": "zstack", "uuid": "c3a228078e8c4f81ba7da0b16fb8d77f" } ], "success": true }... admin >>>query BatchQuery PrometheusQueryLabelValues PrometheusQueryMetadata PrometheusQueryPassThrough PrometheusQueryVmMonitoringData QueryAccessKey QueryAccount QueryAccountResourceRef QueryAffinityGroup QueryAlarm QueryAlert QueryAliyunDiskFromLocal ... QueryVmCdRom QueryVmInstance QueryVmNic QueryVmNicInSecurityGroup QueryVniRange QueryVolume QueryVolumeBackup QueryVolumeSnapshot QueryVolumeSnapshotTree QueryVpcIkeConfigFromLocal QueryVpcIpSecConfigFromLocal QueryVpcRouter QueryVpcUserVpnGatewayFromLocal QueryVpcVpnConnectionFromLocal QueryVpcVpnGatewayFromLocal QueryVtep QueryWebhook QueryZone ZQLQuery admin >>>QueryZone手动执行时通常更适合使用交互模式，而脚本集成时通常更适合使用命令模式。
ZStack的认证和访问管理系统（IAM，Identity and Access Management）支持三种登录方式：账户登录、用户登录、AD/LDAP登录。
账户分为admin管理员账户和普通账户。admin管理员账户使用默认密码password。
LogInByAccount取得一个会话令牌（session token），这个令牌会被zstack-cli自动保存到~/.zstack/cli/session，需要单独维护。admin >>>LogInByAccount accountName=admin password=passwordLogOut命令结束当前会话：admin >>>LogOutLogOut命令可以接受参数sessionUuid, 可选参数，zstack-cli默认会自动读取已保存的session。
[root@localhost ~]# zstack-cli StartVmInstance uuid=f1bd87fe2a40498db78ee596766f57b0admin >>>StartVmInstance uuid=f1bd87fe2a40498db78ee596766f57b0more命令来查看命令历史，例如：[root@localhost ~]# zstack-cli moreadmin >>>more [NUM] COMMAND ------------------------------------------------ [1] LogInByAccount accountName=admin password=****** [2] ['LogOut'] [3] ['QueryVmInstance', 'state=Running'] [4] ['QueryZone'] [5] ['QueryVmInstance'] [6] LogInByAccount accountName=admin password=****** [7] [u'QueryVmInstance', u'count=True', u'state=Stopped'] [8] [u'QueryVmInstance', u'count=True', u'state=Running'] [9] [u'QueryVmInstance', u'count=True'] ...[root@localhost ~]# zstack-cli more 6admin >>>more 6 Command: LogInByAccount accountName=admin password=****** Result: { "inventory": { "accountUuid": "36c27e8ff05c4780bf6d2fa65700f22e", "createDate": "Dec 28, 2017 5:13:59 PM", "expiredDate": "Dec 28, 2017 7:13:59 PM", "userUuid": "36c27e8ff05c4780bf6d2fa65700f22e", "uuid": "c0488a149e1244799317a84ab3378763" }, "success": true } (END)save命令导出命令历史，可以一次保存一个历史也可以一次保存多个历史：[root@localhost ~]# zstack-cli save 1 Saved command: 1 result to file: /root/LogInByAccount-1.jsonadmin >>>save 1 Saved command: 1 result to file: /root/LogInByAccount-1.json[root@localhost ~]# zstack-cli save 1,2,3 [u'CreateDataVolume', u'primaryStorageUuid=4db283cfa9ac4b0a9994aab52bff4069', u'diskOfferingUuid=7c3ba7609e2e44d2a429e93e2944871e', u'name=volume', u'systemTags=localStorage::hostUuid::37bfae93611541039aec7ae87a204e5a'] Saved command: 1 result to file: /usr/local/CreateDataVolume-1.json [u'CreateDataVolume', u'primaryStorageUuid=4db283cfa9ac4b0a9994aab52bff4069', u'diskOfferingUuid=7c3ba7609e2e44d2a429e93e2944871e', u'name=volume', u'systemTags=localStorage::hostUuid::37bfae93611541039aec7ae87a204e5a'] Saved command: 2 result to file: /usr/local/CreateDataVolume-2.json [u'CreateDataVolume', u'primaryStorageUuid=4db283cfa9ac4b0a9994aab52bff4069', u'diskOfferingUuid=7c3ba7609e2e44d2a429e93e2944871e', u'name=volume', u'systemTags=localStorage::hostUuid::37bfae93611541039aec7ae87a204e5a'] Saved command: 3 result to file: /usr/local/CreateDataVolume-3.jsonadmin >>>save 1,2,3 [u'CreateDataVolume', u'primaryStorageUuid=4db283cfa9ac4b0a9994aab52bff4069', u'diskOfferingUuid=7c3ba7609e2e44d2a429e93e2944871e', u'name=volume', u'systemTags=localStorage::hostUuid::37bfae93611541039aec7ae87a204e5a'] Saved command: 1 result to file: /usr/local/CreateDataVolume-1.json [u'CreateDataVolume', u'primaryStorageUuid=4db283cfa9ac4b0a9994aab52bff4069', u'diskOfferingUuid=7c3ba7609e2e44d2a429e93e2944871e', u'name=volume', u'systemTags=localStorage::hostUuid::37bfae93611541039aec7ae87a204e5a'] Saved command: 2 result to file: /usr/local/CreateDataVolume-2.json [u'CreateDataVolume', u'primaryStorageUuid=4db283cfa9ac4b0a9994aab52bff4069', u'diskOfferingUuid=7c3ba7609e2e44d2a429e93e2944871e', u'name=volume', u'systemTags=localStorage::hostUuid::37bfae93611541039aec7ae87a204e5a'] Saved command: 3 result to file: /usr/local/CreateDataVolume-3.jsonsave 1 /tmp学习路径
ZStack Cloud 产品学习路径
快速梳理文档，点击相应文本链接，快速跳转到相应文档的页面，学习 ZStack Cloud 产品。
商务咨询：
400-962-2212 转 1售后咨询：
400-962-2212 转 2商务联系：
sales@zstack.io商务咨询：
400-962-2212 转 1商务联系：
channel@zstack.io商务咨询：
400-962-2212 转 1售后咨询：
400-962-2212 转 2商务联系：
sales@zstack.io商务咨询：
400-962-2212 转 1售后咨询：
400-962-2212 转 2商务联系：
sales@zstack.io商务咨询：
400-962-2212 转 1商务联系：
channel@zstack.io商务咨询：
400-962-2212 转 1商务联系：
channel@zstack.io下载链接已发送至您的邮箱。
如未收到，请查看您的垃圾邮件、订阅邮件、广告邮件。 当您收到电子邮件后，请点击 URL 链接，以完成下载。感谢您使用 ZStack 产品和服务。
成功提交申请。
我们将安排工作人员尽快与您取得联系。感谢您使用 ZStack 产品和服务。
信息提交成功。
我们将安排工作人员尽快与您取得联系，请保持电话畅通。感谢您使用 ZStack 产品和服务。
ZStack微信公众号
zstack_io
ZStack中国社区QQ群
1071894823
版权所有©2022 上海云轴信息科技有限公司 (云轴科技) 沪ICP备15055560号
商务咨询：
400-962-2212 转 1售后咨询：
400-962-2212 转 2商务联系：
sales@zstack.io成功提交申请。
我们将安排工作人员尽快与您取得联系。感谢您使用 ZStack 产品和服务。
