Java V2.0 SDK泛化调用 - 阿里云SDK

阿里云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));
    }
}