API Inspector

API Inspector:云平台API调用的监视工具,用于记录用户在云平台上操作时所关联调用的API。

API Inspector支持记录云平台所有查询类和增删改操作类API的调用情况。所有API记录支持分类筛选,可用于问题排查、学习参考、第三方工具调试使用,可大幅提高开发运维效率。

API Inspector使用方式

使用API Inspector查看API调用可参考以下三步:
  1. 启用API Inspector。
  2. 筛选云平台操作所关联的API记录。
  3. 查看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. 筛选云平台操作所关联的API记录。

    进入ZStack Cloud云平台,在云平台进行相应操作,例如查看报警记录。在云平台UI界面右上角,点击API图标,弹出API记录窗口。

    API调用记录按时间线实时滚动显示,最多可显示最新100条记录。支持两种API调用视图:
    • 按UI请求分组:按UI请求 (GQL) 对所调用的API进行分组归纳,一个UI请求通常对应一个UI操作或查询。点击UI请求详情,可展开查看该UI请求关联的一组后端API。
    • 按平铺:扁平展示云平台操作所关联的所有API记录,包括前端请求和后端请求。
    API Inspector支持筛选和搜索,包括按请求类型筛选、按请求耗时搜索、按请求地址搜索:
    • 按请求类型筛选:平铺视角下,支持按请求类型进行筛选:
      • GQL:UI请求,通常对应一个UI操作或查询
      • GET: 查询类API,查询资源时调用该类API
      • GET-ZQL: 查询类API, 通过ZQL语句查询资源时调用该类API
      • POST: 操作类API,创建资源时调用该类API
      • PUT: 操作类API, 修改资源时调用该类API
      • DELETE: 操作类API,删除资源时调用该类API
    • 按请求耗时搜索:在耗时搜索框内指定一个耗时时间,API Inspector将自动筛选出等于/超过该耗时的请求或没有完成的群跪求。如请求前的耗时时间列显示Webhook,则表示该异步请求正在等待Webhook推送执行结果。
    • 按请求地址搜索:在地址搜索框内指定一个地址或关键字,API Inspector将自动筛选出包含该关键字的请求。

    图 1图 2图 3所示:

    图 1. 按请求类型筛选


    图 2. 按请求耗时搜索


    图 3. 按请求地址搜索


  3. 查看API详情。
    • 查看API详情:点击对应API右侧查看详情按钮,进入详情页,可查看该API记录的详情信息,包括当前API的调用ID、请求方法、请求URL、请求头、请求体、Curl请求示例、响应结果、响应耗时等信息。其中,API调用ID可用于快速定位当前调用在管理节点前端和后端的日志记录,方便快速排查问题。对于GET-ZQL类型请求详情,特别支持查看ZQL语句,方便用户参考学习,快速掌握使用技巧,提高查询效率。所有代码段均支持复制,方便用户在第三方工具调试使用。
    • 查看API日志:点击对应API右侧Log按钮,进入Request Log页,可查看该请求相关的日志信息,帮助用户更好掌握该请求的执行情况。日志支持自动换行展示。
    图 4图 5所示:
    图 4. 查看请求详情


    图 5. 查看请求日志


注意事项

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

历史文档

学习路径

ZStack Cloud 产品学习路径

版本号:

5.3.0
4.8.10
常见问题
常见问题

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 产品和服务。