阿里雲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,最新版本請參見AlibabaCloud.OpenApiClient。
dotnet add package AlibabaCloud.OpenApiClient --version 0.1.8
範例程式碼
樣本:調用RPC風格的API
以調用ECS的DescribeInstanceTypeFamilies介面為例,展示如何使用泛化調用方式。
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
public static AlibabaCloud.OpenApiClient.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
{
// 必填,請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
// 必填,請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
};
config.Endpoint = "ecs-cn-hangzhou.aliyuncs.com";
return new AlibabaCloud.OpenApiClient.Client(config);
}
public static AlibabaCloud.OpenApiClient.Models.Params CreateApiInfo()
{
AlibabaCloud.OpenApiClient.Models.Params params_ = new AlibabaCloud.OpenApiClient.Models.Params
{
// 介面名稱
Action = "DescribeInstanceTypeFamilies",
// 介面版本
Version = "2014-05-26",
// 介面協議
Protocol = "HTTPS",
// 介面 HTTP 方法
Method = "POST",
AuthType = "AK",
Style = "RPC",
// 介面 PATH
Pathname = "/",
// 介面請求體內容格式
ReqBodyType = "json",
// 介面響應體內容格式
BodyType = "json",
};
return params_;
}
public static void Main(string[] args)
{
AlibabaCloud.OpenApiClient.Client client = CreateClient();
AlibabaCloud.OpenApiClient.Models.Params params_ = CreateApiInfo();
// query params
Dictionary<string, object> queries = new Dictionary<string, object>(){};
queries["RegionId"] = "cn-hangzhou";
// runtime options
AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
AlibabaCloud.OpenApiClient.Models.OpenApiRequest request = new AlibabaCloud.OpenApiClient.Models.OpenApiRequest
{
Query = AlibabaCloud.OpenApiUtil.Client.Query(queries),
};
// 複製代碼運行請自行列印 API 的傳回值
// 傳回值實際為 Map 類型,可從 Map 中獲得三類資料:響應體 body、回應標頭 headers、HTTP 返回的狀態代碼 statusCode。
var response = client.CallApi(params_, request, runtime);
Console.WriteLine(response["statusCode"]);
}
}
}
樣本:調用RESTful(ROA)風格的API
以調用Container Service查詢叢集列表資訊為例,展示如何使用泛化調用。
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
public static AlibabaCloud.OpenApiClient.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
{
// 必填,請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
// 必填,請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
};
config.Endpoint = "cs.cn-hangzhou.aliyuncs.com";
return new AlibabaCloud.OpenApiClient.Client(config);
}
public static AlibabaCloud.OpenApiClient.Models.Params CreateApiInfo()
{
AlibabaCloud.OpenApiClient.Models.Params params_ = new AlibabaCloud.OpenApiClient.Models.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",
};
return params_;
}
public static void Main(string[] args)
{
AlibabaCloud.OpenApiClient.Client client = CreateClient();
AlibabaCloud.OpenApiClient.Models.Params params_ = CreateApiInfo();
// runtime options
AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
AlibabaCloud.OpenApiClient.Models.OpenApiRequest request = new AlibabaCloud.OpenApiClient.Models.OpenApiRequest();
// 複製代碼運行請自行列印 API 的傳回值
// 傳回值實際為 Map 類型,可從 Map 中獲得三類資料:響應體 body、回應標頭 headers、HTTP 返回的狀態代碼 statusCode。
var response = client.CallApi(params_, request, runtime);
Console.WriteLine(response["statusCode"]);
}
}
}