本文介绍HTTP调用方式,适用基于API URL发起HTTP/HTTPS GET请求的用户。

如果您使用的是SDK,阿里云CLI(详见什么是阿里云CLI?)或者API Explorer,可以跳过此环节。

调用ROS API接口是通过向ROS API的服务端地址发送HTTP或HTTPS请求,发起API请求的URL由不同参数拼凑而成,有固定的请求语法。URL中包含公共参数、您的签名(详见签名机制)和某个API的具体参数。每篇API文档均给出了URL请求示例供您参考,但是为了方便显示,我们并没有编码这些URL示例,您需要在发起请求前自行编码。我们根据您的签名验证了请求后,会返回结果给您。接口调用成功会显示返回参数,调用失败则显示相应报错,您可以根据公共错误码和具体API错误码分析排查。

服务地址

资源编排服务API的服务接入地址为:ros.aliyuncs.com。

通信协议

支持通过HTTP或HTTPS协议进行请求通信。为了获得更高的安全性,推荐您使用HTTPS协议发送请求。

请求语法

阿里云ROS API支持基于URL发起HTTP/HTTPS GET请求。请求参数需要包含在URL中。本文列举了GET请求中的结构解释,并提供了ROS的服务接入地址(Endpoint)。

以下为ListStacks一条未编码的URL请求示例:

http(s)://ros.aliyuncs.com/?Action=ListStacks
&RegionId=cn-hangzhou
&<公共请求参数>
其中:
  • http(s)指定了请求通信协议。
  • ros.aliyuncs.com指定了ROS的服务接入地址(Endpoint)。
  • Action=ListStacks指定了要调用的API, RegionId=cn-hangzhouListStacks规定的参数。
  • <公共请求参数>是系统规定的公共参数。

请求编码

请求及返回结果都使用UTF-8字符集进行编码。