快速入门

最近更新时间: 2024-01-24 20:06:02

使用API Explorer
API Explorer是建行云提供的一款自动化工具,目前已支持的产品有云服务器CVM、云硬盘CBS、文件存储CFS、私有网络VPC等云产品的API接口调用。可实现在线调用、发送真实请求及签名串自动生成等功能。
API Explorer工具区域划分如下:
1.产品列表区域:列出目前已支持的所有产品。
2.产品接口搜索框:可搜索当前产品下已支持的所有功能接口,支持中英文搜索。
3.产品接口区域:分类目录的形式列出当前产品的分类及下属接口。
4.接口名:当前所选接口的名称及版本。
5.接口所需参数:展示当前接口所需参数,您可勾选“只看必填参数”或“展示所有参数”来进行筛选。
6.功能区:

  • 代码生成:可通过此功能自动生成示例代码。
  • 在线调用:在填写参数后,选择【发送请求】,系统会发送您在左侧填写的参数到对应的接口。请注意该操作等同于真实操作,同时系统会展示响应结果、响应头等信息。
  • 签名串生成:填写签名所需参数后,点击【生成签名】即可在响应区查看签名结果。
  • 参数说明:可查看当前接口所需参数具体信息。
  • 查看文档:可查看当前接口的接口描述、输入参数、输出参数信息

使用错误码中心
您可选择API服务控制台左侧导航栏中的【错误码中心】,进入错误码中心根据产品分类查看错误码说明。
使用文档中心
您可选择API服务控制台左侧导航栏中的【文档中心】,进入产品API文档库。选择对应产品查看API文档信息。