Java V2.0 SDK泛化調用 - Alibaba Cloud SDK

阿里雲SDK不僅支援使用雲產品SDK提供的特化調用方式調用OpenAPI，還支援使用核心SDK提供的泛化調用方式調用OpenAPI，兩種方式的不同請參見泛化調用與特化調用。本文將從擷取API資訊、安裝SDK和程式碼範例來為您介紹如何使用泛化調用。

擷取API資訊

訪問API文檔選擇雲產品，例如選擇Elastic Compute Service。

單擊雲端服務器名稱下面的擷取中繼資料，在中繼資料中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

以調用Container Service查詢叢集列表資訊為例，展示如何使用泛化調用。

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));
    }
}