如何快速查找界面调用的API

ZStack Cloud支持记录UI界面上增删改查操作所调用的API。开发和运维人员可通过参考UI界面上API调用记录快速掌握如何使用API对资源进行操作。

ZStack Cloud提供API Inspector和操作日志两种功能记录界面调用的API。
  • API Inspector:记录云平台上查询类和增删改操作类API的调用情况。
  • 操作日志:记录云平台上增删改操作类API的调用情况,包括API操作名称、操作资源、操作时间、操作结果、以及API入参和返参明细。详细可参考操作日志

本文以创建云主机为例分别介绍如何通过API Inspector和操作日志快速查找界面调用的API。


通过API Inspector查找创建云主机时调用的API

使用API Inspector查看API调用可参考以下四步:
  1. 启用API Inspector。
  2. 创建云主机。
  3. 筛选创建云主机操作所关联的API记录。
  4. 查看API详情。
  1. 启用API Inspector。
    进入管理节点系统,运行以下命令启用API Inspector:
    #启用API Inspector zstack-ctl config_ui --api_inspector=true  # 重启管理节点UI服务 zstack-ctl stop_ui zstack-ctl start_ui
  2. 创建云主机

    ZStack Cloud主菜单,点击资源中心 > 云资源池 > 虚拟资源 > 云主机,进入云主机界面。支持标准创建和快捷创建,本次选择快捷创建。

    可参考以下示例输入相应内容:
    • 名称:设置云主机的名称
    • 简介:可选项,可留空不填
    • 数量:设置云主机数量
    • 标签:可选项,可为云主机绑定一个或多个标签
    • 计算规格:选择云主机的计算规格
    • 镜像:选择创建云主机所需要的镜像
    • 根云盘规格:选择根云盘规格
    • 数据云盘:按需添加数据云盘
    • 网络配置:配置网络和网络服务。

    点击 确定,创建云主机。

  3. 筛选云平台操作所关联的API记录。

    在云平台UI界面右上角,点击API图标,弹出API记录窗口。

    API调用记录按时间线实时滚动显示,最多可显示最新100条记录。用户可按需筛选请求类型,查看云平台操作对应的API记录。每次更改过滤条件会自动清空记录,用户也可一键清空记录。支持筛选以下请求类型API:
    • GET: 查询类API,查询资源时调用该类API
    • GET-ZQL: 查询类API, 通过ZQL语句查询资源时调用该类API
    • POST: 操作类API,创建资源时调用该类API
    • PUT: 操作类API, 修改资源时调用该类API
    • DELETE: 操作类API,删除资源时调用该类API
    图 1所示:
    图 1. 筛选创建云主机的API记录


  4. 查看API详情。

    点击对应API右侧查看详情按钮,进入详情页,可查看该API记录的详情信息,包括当前API的调用ID、请求方法、请求URL、请求头、请求体、Curl请求示例、响应结果、响应耗时等信息。其中,API调用ID可用于快速定位当前调用在管理节点前端和后端的日志记录,方便快速排查问题。

    图 2所示:
    图 2. 查看API记录详情


说明: 使用API Inspector需注意:
  • 启用API Inspector后,涉及大量数据传输,使用完成后,建议及时关闭该功能,否则可能影响云平台UI服务正常运行。可进入管理节点系统运行以下命令关闭该功能:
    #禁用API Inspector zstack-ctl config_ui --api_inspector=false    # 重启管理节点UI服务 zstack-ctl stop_ui zstack-ctl start_ui
  • 建议不要在生产环境使用该功能。

通过操作日志查找创建云主机时调用的API

使用操作日志查看API调用可参考以下两步:
  1. 创建云主机。
  2. 查看创建云主机调用的API记录详情。
  1. 创建云主机

    ZStack Cloud主菜单,点击资源中心 > 云资源池 > 虚拟资源 > 云主机,进入云主机界面。支持标准创建和快捷创建,本次选择快捷创建。

    可参考以下示例输入相应内容:
    • 名称:设置云主机的名称
    • 简介:可选项,可留空不填
    • 数量:设置云主机数量
    • 标签:可选项,可为云主机绑定一个或多个标签
    • 计算规格:选择云主机的计算规格
    • 镜像:选择创建云主机所需要的镜像
    • 根云盘规格:选择根云盘规格
    • 数据云盘:按需添加数据云盘
    • 网络配置:配置网络和网络服务。

    点击 确定,创建云主机。

  2. 查看创建云主机调用的API记录详情

    点击界面右上角操作日志图标,弹出操作日志页面。点击操作历史页面,可查看创建云主机的操作日志。

    图 1所示:
    图 1. 创建云主机操作日志


    点击创建云主机日志,弹出操作详情窗口,可查看创建云主机操作所涉及的操作资源、操作结果、操作相关时间、操作员、登录IP、以及API操作名称(CreateVmInstance)、API执行明细等相关信息。

    用户通过系统登录或第三方API工具(例如Postman)创建云主机时,可参考该API操作名称以及对应的请求参数和返回参数进行API调用。其中,API调用ID可用于快速定位当前调用在管理节点前端和后端的日志记录,方便快速排查问题。

    图 2图 3所示:
    图 2. 操作详情


    图 3. API请求参数和返回参数详情


历史版本

学习路径

ZStack Cloud 产品学习路径

版本号

常见问题(V5.2.0)

ZStack Cloud 产品学习路径

快速梳理文档,点击相应文本链接,快速跳转到相应文档的页面,学习 ZStack Cloud 产品。

我知道了

升级提醒

若您选择升级至4.0.0及之后版本,请注意以下功能调整:

1. 云路由器全面升级为VPC路由器,云路由网络全面升级为VPC网络,不再单独设云路由器页面。升级全程无感知,相关业务不受任何影响。

2. 企业管理账号体系取代用户组与用户,不再单独设用户/用户组页面,不可再使用用户/用户组账号登录云平台。升级前,请先将“用户组与用户”纳管的账号数据妥善迁移至“企业管理”纳管,再执行升级操作。注意:对于admin创建并具备admin权限的用户账号同步取消,如有需要,可使用企业管理账号体系中的平台管理员实现相同功能。

3. 调整AD/LDAP与账户的对接管理方式,统一由企业管理纳管,不再单独设AD/LDAP页面。升级前,请先将“账户”对接纳管的AD/LDAP账号数据妥善迁移至“企业管理”纳管,再执行升级操作。

如对上述升级提醒有任何疑问或需要升级帮助,请联系ZStack官方技术支持

下载ZStack企业版

您已填写过基本信息?点击这里

姓名应该不少于两个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
公司名称不应该少于4个字符
邮箱格式错误

下载链接将会通过邮件形式发送至您的邮箱,请谨慎填写。

同意 不同意

我已阅读并同意云轴科技 《法律声明》《隐私政策》用户管理规则及公约

下载ZStack企业版

还未填写过基本信息?点击这里

邮箱或手机号码格式错误
同意 不同意

我已阅读并同意云轴科技 《法律声明》《隐私政策》用户管理规则及公约

验证手机号
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
同意 不同意

我已阅读并同意云轴科技 《法律声明》《隐私政策》用户管理规则及公约

登录观看培训视频
仅对注册用户开放,请 登录 观看培训视频

业务咨询:

400-962-2212 转 1

售后咨询:

400-962-2212 转 2

其他(漏洞提交、投诉举报等)

400-962-2212 转 3
ZStack认证培训咨询
姓名应该不少于两个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
公司名称不应该少于4个字符
邮箱格式错误

同意 不同意

我已阅读并同意云轴科技 《法律声明》《隐私政策》用户管理规则及公约

业务咨询:

400-962-2212 转 1

ZStack学院:

training@zstack.io
申请ZStack多机版
姓名应该不少于两个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
公司名称不应该少于4个字符
邮箱格式错误

同意 不同意

我已阅读并同意云轴科技 《法律声明》《隐私政策》用户管理规则及公约

业务咨询:

400-962-2212 转 1

售后咨询:

400-962-2212 转 2

其他(漏洞提交、投诉举报等)

400-962-2212 转 3
立即咨询
姓名应该不少于两个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
公司名称不应该少于4个字符
邮箱格式错误

同意 不同意

我已阅读并同意云轴科技 《法律声明》《隐私政策》用户管理规则及公约

业务咨询:

400-962-2212 转 1

售后咨询:

400-962-2212 转 2

其他(漏洞提交、投诉举报等)

400-962-2212 转 3
培训认证合作伙伴申请
姓名应该不少于2个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
邮箱格式错误
城市名称不应该少于2个字符
公司名称不应该少于4个字符
职位名称不应该少于2个字符

同意 不同意

我已阅读并同意云轴科技 《法律声明》《隐私政策》用户管理规则及公约

业务咨询:

400-962-2212 转 1

商务联系:

channel@zstack.io
ZStack&工信人才联合证书申请
已获得ZStack原厂证书
未获得ZStack原厂证书
请填写您的基本信息
姓名应该不少于2个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
邮箱格式错误
城市名称不应该少于2个字符
公司/学校名称不应该少于4个字符
证书类型
ZCCT
ZCCE
ZCCA
ZCPC-ISP
申请ZStack&工信人才联合证书须支付工本费,是否可以接受
同意 不同意

我已阅读并同意云轴科技 《法律声明》《隐私政策》用户管理规则及公约

业务咨询:

400-962-2212 转 1

商务联系:

channel@zstack.io

下载链接已发送至您的邮箱。

如未收到,请查看您的垃圾邮件、订阅邮件、广告邮件。 当您收到电子邮件后,请点击 URL 链接,以完成下载。

下载链接已发送至您的邮箱。

如未收到,请查看您的垃圾邮件、订阅邮件、广告邮件。
或点击下方URL链接 (IE内核浏览器请右键另存为), 完成下载:

感谢您使用 ZStack 产品和服务。

成功提交申请。

我们将安排工作人员尽快与您取得联系。

感谢您使用 ZStack 产品和服务。

信息提交成功。

我们将安排工作人员尽快与您取得联系,请保持电话畅通。

感谢您使用 ZStack 产品和服务。

预约沟通

联系我们

业务咨询
400-962-2212 转 1
售后咨询
400-962-2212 转 2
其他业务(漏洞提交、投诉举报等)
400-962-2212 转 3

联系我们

回到顶部

产品试用申请
请选择您要试用的产品
ZStack Cloud 企业版
ZStack Cloud 混合云版
ZStack Cloud 基础版
ZStack Cloud 标准版
请填写您的基本信息
姓名应该不少于两个字符
手机号格式错误
验证码填写错误 获取短信验证码 60 秒后可重发
公司名称不应该少于4个字符
邮箱格式错误

商务咨询:

400-962-2212 转 1

售后咨询:

400-962-2212 转 2

商务联系:

sales@zstack.io

成功提交申请。

我们将安排工作人员尽快与您取得联系。

感谢您使用 ZStack 产品和服务。