全部产品
云市场

OpenAPI Explorer 使用说明

更新时间:2018-08-02 11:01:20

阿里云OpenAPI Explorer是一个提供在线API调试功能的平台。集成了阿里云各个产品所提供的API,具有快速检索、查阅文档、在线调试、生成SDK等功能。本文主要介绍通过OpenAPI Explorer使用E-HPC的所有API接口。

功能简介

搜索产品及API接口

打开阿里云OpenAPI Explorer,进入主界面,拖动产品列表或者在云产品列表下的搜索栏中进行E-HPC产品的搜索。拖动产品列表或者搜索“弹性高性能计算”可以找到E-HPC提供的所有API接口,可以针对所需要的API进行搜索。API搜索界面

在线调试示例

以使用OpenAPI Explorer进行集群的增加用户(AddUsers)操作为例,首先使用ListClusters接口进行集群的查询,向下拖动列表找到ListClusters接口,或在搜索栏中搜索ListClusters接口,进行API参数的填写,示例中查询区域华东2(对应的RegionID为cn-shanghai)中的用户集群。

说明:加红点为必填的参数,参数的格式、默认值以及注意事项会在填写框下方标注。在示例代码板块显示的是SDK的示例代码,有Java、NodeJS、PHP、Python等版本。用户可以参考示例代码进行自己的代码编写。示例代码中包含了需要import的库,库的使用示例,设置参数以及发起请求示例。用户参照示例代码,可以在本地进行API的使用与调试。

参数填写

填写完参数之后,点击下方的“发送请求”按钮,会在在线调试板块显示该API的请求状态、请求URL、响应结果等相关信息。这里请求返回的结果可以展开查看,ListCluster这个API查询到在华东2(cn-shanghai)这个区域中所有集群的信息,具体返回字段意义请参照E-HPC产品帮助文档中ListCluster。请求返回

查询完集群信息之后,通过返回的结果可以找到想进行增加用户操作的集群ID,然后找到AddUsers接口,进行增加用户的操作。

说明:这里的User参数是一个嵌套参数,也就是说一个User参数包含三个子参数信息(Name,Group,Password)。嵌套参数可以点击参数右侧加号进行批量添加。

嵌套参数界面

在返回成功之后,用户可以选择继续使用API接口进行后续操作,比如使用ListUsers进行用户列表的查询,也可以选择使用E-HPC管理控制台进行后续操作。

查看对应官方文档

在OpenAPI Explorer使用API接口时,如果对该接口的含义不了解、对API字段描述不清楚、对返回字段有疑问或是对错误码信息需要进一步了解的,可以直接在该API页面下方点击“查看当前文档”进行官方文档的跳转,查询对应接口的详细信息。