调用RPC API和RESTful API

Apr 30 2021

分类：图文教程

已被围观 623 次

阿里云云产品的API分为RPC和RESTful两种类型，大部分产品使用的是RPC风格。当您使用阿里云CLI调用接口时，不同风格的API，调用方式不同。

在阿里云CLI中，使用的命令行结构如下：

aliyun <command> <subcommand> [options and parameters]

aliyun：阿里云工具名。
command：指定一个顶级命令。
1. 通常表示命令行工具中支持的阿里云产品基础服务，例如ecs、rds等。
2. 也表示命令行工具本身的功能命令，例如help、configure等。
subcommand：指定要执行操作的附加子命令，即具体的某一项操作。
options and parameters：指定用于控制阿里云CLI行为的选项或者API参数选项，其选项值可以是数字、字符串和json结构字符串等。

调用产品接口时，首先需要判断API类型，选择标准的命令结构发起调用。您可以通过以下特点判断API类型：

调用RPC API

在阿里云CLI中，调用RPC API时，基本命令结构如下：

aliyun <product> <ApiName> [--parameter1 value1 --parameter2 value2 ...]

代码示例：

aliyun rds DescribeDBInstances --PageSize 50

aliyun ecs DescribeRegions

aliyun rds DescribeDBInstanceAttribute --DBInstanceId xxxxxx

部分阿里云产品如容器服务是RESTful API。在阿里云CLI中，调用RESTful API时，基本命令结构如下：

 aliyun 云产品code [GET|PUT|POST|DELETE] <PathPattern> --body "$(cat input.json)"

GET请求

请求结构：

aliyun 云产品code GET /资源

示例命令：

试用

aliyun cs GET /clusters

POST请求

请求结构：

aliyun 云产品code POST /资源 --body "$(cat input.json)"

示例命令：

aliyun cs  POST /clusters/<cluster_id>/attach --header "Content-Type=application/json" --body "$(cat attach.json)"