泛化調用
阿里云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();