本文介绍如何使用OpenAPI调用ListInstances接口查询指定地域下轻量应用服务器实例的详细信息。
步骤一:查看OpenAPI文档
在调用OpenAPI前,建议您先阅读对应接口文档,了解、学习调用该接口所需要的参数及权限等。更多信息,请参见API概览。
步骤二:创建RAM用户并完成授权
阿里云账号拥有所有API的访问权限,建议您创建并使用RAM用户进行API访问或日常运维。
本步骤主要用于创建一个具有只读轻量应用服务器资源权限的RAM用户。
如果您已创建RAM用户且已完成授权,可跳过此步骤。
使用阿里云账号登录RAM控制台。
创建RAM用户。
在左侧导航栏,选择
。在用户页面,单击创建用户。
在创建用户页面,设置登录名称和显示名称,并将访问方式设置为控制台访问。
单击确定。
创建RAM用户成功后,请记录用户登录名称和密码,您在调用OpenAPI时,需要使用该RAM用户登录阿里云OpenAPI开发者门户。
为RAM用户授权。
说明创建RAM用户后,该RAM用户无任何操作轻量应用服务器的权限。您需要为该RAM用户授予系统策略(AliyunSWASFullAccess)或自定义策略。本案例以授予RAM用户AliyunSWASFullAccess策略为例,AliyunSWASOpenFullAccess策略具备管理轻量应用服务器的权限。如果您需要新建自定义权限,请参见授权信息。
在用户页面,单击目标RAM用户对应的添加权限。
在添加权限面板,在权限策略中搜索选中输入关键字
swas
进行搜索,选择AliyunSWASFullAccess策略。单击确认新增授权,完成授权操作。
步骤三:调用OpenAPI
OpenAPI平台提供了多种编程语言(Java、Go、Python、TypeScript、PHP、C++ 等)的SDK。开发者只需要集成SDK,通过SDK暴露的方法直接调用OpenAPI 。SDK统一封装了签名逻辑、超时机制、重试机制,并根据文档返回结构化 Response 对象,易于开发。
获取SDK示例代码
以获取Java SDK示例代码为例,其他语言的获取方式相同。
使用RAM用户访问阿里云OpenAPI门户。
选择云产品为轻量应用服务器。
在顶部菜单栏,选择工具中心>在线调试。
在左侧导航栏,找到并单击ListInstances接口,选择服务地址为华东1(杭州),表示查询杭州地域下所有轻量应用服务器实例的详细信息。
说明如果需要根据更多信息筛选实例,在左侧的参数配置页签,输入需要的配置参数。
在SDK示例页签,选择SDK版本和SDK语言。推荐使用V2.0版本。关于V2.0和V1.0的区别,请参见V1.0 SDK和V2.0 SDK区别。
单击下载完整工程可以下载完整的SDK工程。下载完后完成解压。
运行SDK示例代码
以运行Java SDK示例代码为例。
使用IntelliJ IDEA,单击File->Open,选择解压后的工程文件夹,等待Maven自动安装依赖信息。
在调用之前,需要先获取访问凭证AccessKey,建议使用RAM用户的AccessKey。更多信息,请参见创建RAM用户的AccessKey。
重要获取RAM用户的AccessKey之后,还需要在环境变量中设置AccessKey,具体操作步骤请参见在Linux、macOS和Windows系统配置环境变量。
运行示例代码。
双击打开Sample,确认无报错后,运行代码。
查看运行结果。在底部控制台按下
ctrl+f
,搜索statusCode
,如果看到"statusCode":200
表示调用成功。
报错处理
code: 404, Specified access key is not found or invalid.
您在环境变量中配置的AccessKey没有生效,建议重启IDE或系统后重试。