PHP 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

在Terminal中执行以下命令安装核心SDK。

composer require alibabacloud/darabonba-openapi

代码示例

示例：调用RPC风格的API

以调用ECS的DescribeRegions接口为例，展示如何使用泛化调用方式。

<?php

namespace AlibabaCloud\SDK\Sample;

require_once 'vendor/autoload.php';

use AlibabaCloud\OpenApiUtil\OpenApiUtilClient;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\Config;
use Darabonba\OpenApi\Models\OpenApiRequest;
use Darabonba\OpenApi\Models\Params;
use Darabonba\OpenApi\OpenApiClient;

class Sample
{
    public static function main()
    {
        // 从环境变量中获取访问密钥，确保环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET 已设置。
        $config = new Config([
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
        ]);
        // 设置 API 调用的服务接入点，这里以 ECS 服务的 Hangzhou 地域为例。
        $config->endpoint = "ecs-cn-hangzhou.aliyuncs.com";
        $client = new OpenApiClient($config);
        $params = new Params([
            "action" => "DescribeRegions", // API名称
            "version" => "2014-05-26", // API版本
            "protocol" => "HTTPS", // API协议
            "method" => "POST", // API请求方法
            "authType" => "AK", // 鉴权类型
            "style" => "RPC", // 请求风格
            "pathname" => "/", // 接口 PATH
            "reqBodyType" => "json", // 接口请求体内容格式
            "bodyType" => "json" // 接口响应体内容格式
        ]);
        // 设置查询参数
        $query = ["InstanceChargeType" => "PostPaid"];
        // 创建OpenApiRequest实例，包含查询参数和请求主体。
        $request = new OpenApiRequest([
            "query" => OpenApiUtilClient::query($query),
        ]);
        // 创建RuntimeOptions实例，可以在这里配置运行时选项，如超时时间等。
        $runtime = new RuntimeOptions([]);
        // 返回值为 Map 类型，可从 Map 中获得三类数据：响应体 body、响应头 headers、HTTP 返回的状态码 statusCode。
        $response = $client->callApi($params, $request, $runtime);
        var_dump($response);
    }
}

Sample::main();

示例：调用RESTful（ROA）风格的API

以调用容器服务查询集群列表信息为例，展示如何使用泛化调用。

<?php

namespace AlibabaCloud\SDK\Sample;

require_once 'vendor/autoload.php';

use Darabonba\OpenApi\OpenApiClient;
use AlibabaCloud\OpenApiUtil\OpenApiUtilClient;

use Darabonba\OpenApi\Models\Config;
use Darabonba\OpenApi\Models\Params;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Darabonba\OpenApi\Models\OpenApiRequest;

class Sample
{
    public static function main()
    {
        $config = new Config([
            "accessKeyId" => getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            "accessKeySecret" => getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
        ]);
        $config->endpoint = "cs.cn-qingdao.aliyuncs.com";
        $client = new OpenApiClient($config);
        $params = new Params([
            // 接口名称
            "action" => "DescribeClustersV1",
            // 接口版本
            "version" => "2015-12-15",
            // 接口协议
            "protocol" => "HTTPS",
            // 接口 HTTP 方法
            "method" => "GET",
            "authType" => "AK",
            "style" => "ROA",
            // 接口 PATH
            "pathname" => "/api/v1/clusters",
            // 接口请求体内容格式
            "reqBodyType" => "json",
            // 接口响应体内容格式
            "bodyType" => "json"
        ]);
        // query params
        $queries = [
            "name" => "cluster-demo"
        ];
        $request = new OpenApiRequest([
            "query" => OpenApiUtilClient::query($queries)
        ]);
        // runtime options
        $runtime = new RuntimeOptions([]);
        // 返回值为 Map 类型，可从 Map 中获得三类数据：响应体 body、响应头 headers、HTTP 返回的状态码 statusCode。
        $response = $client->callApi($params, $request, $runtime);
        var_dump($response);
    }
}

Sample::main();