首页 OpenAPI Explorer 操作指南 通过命令行调用API

通过命令行调用API

更新时间: 2023-07-10 16:43:20

OpenAPI Explorer内置了云命令工具Cloud Shell。Cloud Shell是基于阿里云CLI构建的一款网页版CLI工具,无需安装和配置AccessKey,登录后即可使用。

阿里云云产品的API分为RPC和RESTful两种类型,大部分产品提供RPC API,例如云服务器ECS,云数据库RDS和负载均衡等。

不同类型的API的调用方法也不同。您可以通过以下特点判断API类型:

  • API参数中包含Action字段的是RPC API,需要PathPattern参数的是RESTful API。

  • 一般情况下,一个云产品的API类型是一致的。

启动Cloud Shell

  1. 登录OpenAPI 门户

  2. 在顶部导航栏,单击选择云产品,在面板中根据需要选择云产品。

  3. 进入云产品主页,在顶部导航栏单击API调试,选择CLI示例页签。

  4. CLI示例页签,单击Cloud Shell图标image.png,启动Cloud Shell。

    您也可以直接访问阿里云Cloud Shell

在Cloud Shell中调用RPC API

在云命令中调用RPC API需遵循以下格式:

aliyun <ProductCode> <ActionName> [--parameter1 value1 --paramter2 value2]

参数

说明

示例

ProductCode

需要调用的云产品code,例如云服务器的产品code为ecs,负载均衡的产品code 为slb

您可以执行aliyun --help命令查看产品code。

在Cloud Shell中执行以下命令,查看指定ECS实例的配置信息。

说明

运行前,请替换实例ID。

aliyun ecs DescribeInstanceAttribute --InstanceId i-bp198exxxxxx | jq 

ActionName

需要调用的API。例如使用 ECS 的 DescribeInstanceAttribute 接口查看一个 ECS 实例的详细信息。

parameter

需要传入的请求参数。具体参见各云产品的API文档。

在Cloud Shell中调用RESTful API

部分阿里云产品如容器服务是RESTful API。RESTful API与RPC API的调用方式不同。使用阿里云CLI调用RESTful API的基本结构如下:

  • GET请求

    aliyun <ProductCode> GET /<Resource>

    示例

    aliyun cs GET /clusters
  • POST请求

    aliyun <ProductCode> POST /<Resource> --body "$(cat input.json)"

    示例

    aliyun cs POST /clusters/<cluster-id> --header "Content-Type=application/json" --body "$(cat attach.json)"
  • DELETE请求

    aliyun <ProductCode> DELETE /<Resource>

    示例

    aliyun cs DELETE /clusters/<cluster-id>
阿里云首页 OpenAPI Explorer 相关技术圈