泛化調用
阿里云SDK不僅支持使用云產品SDK提供的特化調用方式調用OpenAPI,還支持使用核心SDK提供的泛化調用方式調用OpenAPI,兩種方式的不同請參見泛化調用與特化調用。本文將從獲取API信息、安裝SDK和代碼示例來為您介紹如何使用泛化調用。
獲取API信息
訪問API文檔選擇云產品,例如選擇云服務器ECS。
單擊云服務器名稱下面的獲取元數據,在元數據中
info.style
查看云產品支持的OpenAPI風格(RPC或者ROA)。說明該位置獲取的元數據中包含了云產品的所有API信息,如果您想要查看單個API的元數據,請查看步驟2。
選擇將要調用的API,單擊右上角獲取元數據。
在元數據中,定義了API支持的網絡協議、請求方式、參數及參數位置等信息。如下圖所示的RunInstances元數據中:
支持的網絡協議有HTTP和HTTPS,建議使用HTTPS。
支持的請求方式有GET和POST,兩者請求方式調用結果無任何差異,但GET請求只支持 32 KB 以內的請求包,所以推薦使用POST請求。
支持的參數有RegionId、ImageId等,參數位置在query,表示參數是要拼接在請求URL后面,例如https://ecs.cn-beijing.aliyuncs.com/?ImageId=aliyun_2_1903_x64_20G_alibase_20231221.vhd&InstanceChargeType=PostPaid&InstanceType=ecs.e-c1m1.large&InternetChargeType=PayByTraffic&MinAmount=1&Password=test%401234&RegionId=cn-beijing&SecurityGroupId=sg-2zec0dm6qi66XXXXXXXX&SystemDisk.Category=cloud_essd&SystemDisk.Size=40&VSwitchId=vsw-2ze3aagwn397gXXXXXXXX。
說明元數據中其他支持的內容對簽名無影響,這里暫不詳細說明。更多元數據的信息,請參見元數據使用指南。
安裝SDK
在pom.xml中添加以下依賴安裝核心SDK。
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>tea-openapi</artifactId>
<version>0.2.8</version>
</dependency>
代碼示例
示例:調用RPC風格的API
以調用ECS的DescribeRegions接口為例,展示如何使用泛化調用方式。
import com.aliyun.teaopenapi.Client;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teaopenapi.models.OpenApiRequest;
import com.aliyun.teaopenapi.models.Params;
import com.aliyun.teautil.models.RuntimeOptions;
import com.google.gson.Gson;
import java.util.HashMap;
import java.util.Map;
import static com.aliyun.openapiutil.Client.query;
public class Sample {
public static void main(String[] args) throws Exception {
Config config = new Config()
.setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
.setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
.setEndpoint("ecs-cn-hangzhou.aliyuncs.com");
Client client = new Client(config);
Params params = new Params()
.setStyle("RPC") // API風格
.setVersion("2014-05-26") // API版本號
.setMethod("POST") // 請求方法
.setAction("DescribeRegions") // API名稱
.setPathname("/") // API請求路徑
.setProtocol("HTTPS")
.setAuthType("AK")
.setReqBodyType("json")
.setBodyType("json");
// 設置查詢參數
Map<String, Object> queries = new HashMap<>();
queries.put("InstanceChargeType", "PrePaid");
// 設置運行時選項
RuntimeOptions runtime = new RuntimeOptions();
OpenApiRequest request = new OpenApiRequest()
.setQuery(query(queries));
// 返回值為Map類型,可從Map中獲得三類數據:body、headers、statusCode(HTTP返回的狀態碼 )。
Map<String, ?> response = client.callApi(params, request, runtime);
System.out.println(new Gson().toJson(response));
}
}
示例:調用RESTful(ROA)風格的API
以調用容器服務查詢集群列表信息為例,展示如何使用泛化調用。
import com.aliyun.teaopenapi.Client;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teaopenapi.models.OpenApiRequest;
import com.aliyun.teaopenapi.models.Params;
import com.aliyun.teautil.models.RuntimeOptions;
import com.google.gson.Gson;
import java.util.HashMap;
import java.util.Map;
import static com.aliyun.openapiutil.Client.query;
public class Test3 {
public static void main(String[] args_) throws Exception {
Config config = new Config()
.setAccessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))
.setAccessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
.setEndpoint("cs.cn-qingdao.aliyuncs.com");
Client client = new Client(config);
Params params = new Params()
.setStyle("ROA")
// 接口版本
.setVersion("2015-12-15")
// 接口名稱
.setAction("DescribeClustersV1")
// 接口 PATH
.setPathname("/api/v1/clusters")
// 接口協議
.setProtocol("HTTPS")
// 接口 HTTP 方法
.setMethod("GET")
.setAuthType("AK")
// 接口請求體內容格式
.setReqBodyType("json")
// 接口響應體內容格式
.setBodyType("json");
// 設置查詢參數
Map<String, Object> queries = new HashMap<>();
queries.put("name", "cluster-demo");
OpenApiRequest request = new OpenApiRequest()
.setQuery(query(queries));
RuntimeOptions runtime = new RuntimeOptions();
// 返回值為 Map 類型,可從 Map 中獲得三類數據:響應體 body、響應頭 headers、HTTP 返回的狀態碼 statusCode。
Map<String, ?> response = client.callApi(params, request, runtime);
System.out.println(new Gson().toJson(response));
}
}