PHP 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

在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

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

<?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();