Alibaba Cloud SDK：泛化調用

特點

1. 輕量級：僅需安裝Core包即可調用所有OpenAPI，無需依賴各產品的獨立SDK。

2. 快速迭代相容性：當雲產品尚未提供相應的SDK，或當新API發布但SDK未能及時更新時，可以使用泛化調用。這樣，無需等待SDK的更新，即可及時調用最新發行的API介面。

更多介紹，請參見泛化調用與特化調用。

使用說明

在使用泛化調用之前，必須手動擷取並配置OpenAPI的版本號碼、請求路徑、參數類型等中繼資料資訊。可以通過查看OpenAPI中繼資料來擷取有關OpenAPI的API風格、請求參數、資源路徑等相關資訊。

安裝核心SDK

在Terminal中執行以下命令安裝核心SDK。

go get -u github.com/aliyun/alibaba-cloud-sdk-go/sdk

調用OpenAPI

初始化請求用戶端

通過在aliyunsdkcore包中建立client模組以初始化請求用戶端，並通過該Client發起OpenAPI調用。此處僅列舉使用AccessKey（簡稱：AK）初始化用戶端的方式，更多初始化方式請參見管理訪問憑據。

import (
	"fmt"
	"os"
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk"
)

// 使用 AccessKey 直接初始化。os.Getenv表示從環境變數中擷取存取金鑰
client, err := sdk.NewClientWithAccessKey("cn-hangzhou", os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
	if err != nil {
		panic(err)
	}

配置OpenAPI資訊及請求參數

通過CommonRequest來配置OpenAPI所需的公用請求參數及介面請求參數。關於更多公用請求參數的介紹及使用請參見進階配置。

        // 2.建立CommonRequest對象並配置OpenAPI基本資料和請求參數。
        request := requests.NewCommonRequest()
        // 2.1 配置OpenApi基本資料
	request.Domain = "ecs-cn-hangzhou.aliyuncs.com" // API服務地址
	request.Version = "2014-05-26" // API版本號碼
	request.ApiName = "DescribeInstanceStatus" // API名稱，當調用RPC風格API時，必須配置ApiName()指定介面名稱
	request.Method = "POST" // 請求方式。
	request.Scheme = "https" // 請求協議：HTTPS或HTTP，建議使用HTTPS。
	// request.PathPattern = "/"   // 資源路徑，ROA介面必傳。RPC介面禁止設定該參數。

        // 2.2 配置請求參數
	// 情境一：query參數通過QueryParams["key"] = "value"設定
	instanceIds := []string{
		"i-bp1axhql4dqXXXXXXXX",
		"i-bp124uve8zqXXXXXXXX",
	}
	request.QueryParams["RegionId"] = "cn-hangzhou"
	for i, id := range instanceIds {
	request.QueryParams[fmt.Sprintf("InstanceId.%d", i+1)] = id
	}

	// 情境二：body參數通過FormParams["key"] = "value"設定
	// request.FormParams["key1"] = "value1"
	// request.FormParams["key2"] = "value2"
	// request.FormParams["key3"] = "value3"

發起請求

通過client調用ProcessCommonRequest發起請求。

// 發起請求
response, err := client.ProcessCommonRequest(request)
	if err != nil {
		panic(err)
	}
	// 解析響應內容（JSON 格式），包含RequestId以及OpenAPI的返回參數。
	fmt.Print(response.GetHttpContentString())

程式碼範例

樣本：調用RPC風格的API

以調用ECS的DescribeRegions介面為例，展示如何使用泛化調用方式。

package main

import (
	"fmt"
	"os"
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk"
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
)
func main() {
	client, err := sdk.NewClientWithAccessKey("cn-hangzhou", os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
	if err != nil {
		panic(err)
	}
	request := requests.NewCommonRequest()
	request.Domain = "ecs-cn-hangzhou.aliyuncs.com"
	request.Version = "2014-05-26"
	request.ApiName = "DescribeInstanceStatus"
	request.Method = "POST"
	request.Scheme = "HTTPS"

	instanceIds := []string{
		"i-bp1axhql4dqXXXXXXXX",
		"i-bp124uve8zqXXXXXXXX",
	}
	request.QueryParams["RegionId"] = "cn-hangzhou"
	for i, id := range instanceIds {
		request.QueryParams[fmt.Sprintf("InstanceId.%d", i+1)] = id
	}
	request.QueryParams["PageNumber"] = "1"
	request.QueryParams["PageSize"] = "30"
	response, err := client.ProcessCommonRequest(request)
	if err != nil {
		panic(err)
	}
	fmt.Print(response.GetHttpContentString())
}

樣本：調用RESTful（ROA）風格的API

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

package main

import (
	"fmt"
	"os"

	"github.com/aliyun/alibaba-cloud-sdk-go/sdk"
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
)

func main() {
	client, err := sdk.NewClientWithAccessKey("cn-hangzhou", os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))
	if err != nil {
		panic(err)
	}
	request := requests.NewCommonRequest()
	request.Domain = "cs.aliyuncs.com" // API服務地址
	request.Version = "2015-12-15" // API版本號碼
	// 因為是Restful介面，因此需指定PathPattern
	request.PathPattern = "/api/v1/clusters" // API資源路徑，當調用ROA風格API時，必須配置set_uri_pattern()指定完整資源路徑。從OpenAPI中繼資料中data.path擷取資源路徑。
	request.Method = "GET" // 請求方式
	request.Scheme = "https"  // 請求協議：HTTPS或HTTP，建議使用HTTPS。

	response, err := client.ProcessCommonRequest(request)
	if err != nil {
		panic(err)
	}
	fmt.Print(response.GetHttpContentString())
}