全部產品
Search
文件中心

Alibaba Cloud SDK:泛化調用

更新時間:Jul 19, 2024

阿里雲SDK不僅支援使用雲產品SDK提供的特化調用方式調用OpenAPI,還支援使用核心SDK提供的泛化調用方式調用OpenAPI,兩種方式的不同請參見泛化調用與特化調用。本文將從擷取API資訊、安裝SDK和程式碼範例來為您介紹如何使用泛化調用。

擷取API資訊

訪問API文檔選擇雲產品,例如選擇Elastic Compute Service。

  1. 單擊雲端服務器名稱下面的擷取中繼資料,在中繼資料中info.style查看雲產品支援的OpenAPI風格(RPC或者ROA)。

    image

    image

    說明

    該位置擷取的中繼資料中包含了雲產品的所有API資訊,如果您想要查看單個API的中繼資料,請查看步驟2。

  2. 選擇將要調用的API,單擊右上方擷取中繼資料

    image

    在中繼資料中,定義了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。

    image

    說明

    中繼資料中其他支援的內容對簽名無影響,這裡暫不詳細說明。更多中繼資料的資訊,請參見中繼資料使用指南

安裝SDK

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

go get github.com/alibabacloud-go/darabonba-openapi/v2/client

程式碼範例

樣本:調用RPC風格的API

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

package main

import (
	"fmt"
	"os"

	openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
	openapiutil "github.com/alibabacloud-go/openapi-util/service"
	util "github.com/alibabacloud-go/tea-utils/v2/service"
	"github.com/alibabacloud-go/tea/tea"
)

func main() {
	// 從環境變數中擷取存取金鑰ID和密鑰Secret
	config := &openapi.Config{
		AccessKeyId:     tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
		AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
	}
	// 設定用戶端的服務存取點
	config.Endpoint = tea.String("ecs-cn-hangzhou.aliyuncs.com")
	// 初始化並返回用戶端執行個體
	client, err := openapi.NewClient(config)
	if err != nil {
		panic(err)
	}
	params := &openapi.Params{
		// 設定API的行動、版本和其他必要參數
		Action:      tea.String("DescribeRegions"),
		Version:     tea.String("2014-05-26"),
		Protocol:    tea.String("HTTPS"),
		Method:      tea.String("POST"),
		AuthType:    tea.String("AK"),
		Style:       tea.String("RPC"),
		Pathname:    tea.String("/"),
		ReqBodyType: tea.String("json"),
		BodyType:    tea.String("json"),
	}

	// 設定查詢參數
	query := map[string]interface{}{
		"InstanceChargeType": tea.String("PostPaid"),
	}
	// 設定運行時選項
	runtime := &util.RuntimeOptions{}
	// 建立API請求並設定參數
	request := &openapi.OpenApiRequest{
		Query: openapiutil.Query(query),
	}
	// 調用API並處理返回結果
	response, err := client.CallApi(params, request, runtime)
	if err != nil {
		panic(err)
	}
	// 傳回值為Map類型,可從Map中獲得三類資料:body、headers、HTTP返回的狀態代碼 statusCode。
	fmt.Println(response["body"])
}

樣本:調用RESTful(ROA)風格的API

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

package main

import (
	"fmt"
	"os"

	openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
	openapiutil "github.com/alibabacloud-go/openapi-util/service"
	util "github.com/alibabacloud-go/tea-utils/v2/service"
	"github.com/alibabacloud-go/tea/tea"
)

func main() {
	// 從環境變數中擷取存取金鑰ID和密鑰Secret
	config := &openapi.Config{
		AccessKeyId:     tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
		AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
	}
	// Endpoint 請參考 https://api.aliyun.com/product/CS
	config.Endpoint = tea.String("cs.cn-qingdao.aliyuncs.com")
	client, err := openapi.NewClient(config)
	if err != nil {
		panic(err)
	}
	params := &openapi.Params{
		// 介面名稱
		Action: tea.String("DescribeClustersV1"),
		// 介面版本
		Version: tea.String("2015-12-15"),
		// 介面協議
		Protocol: tea.String("HTTPS"),
		// 介面 HTTP 方法
		Method:   tea.String("GET"),
		AuthType: tea.String("AK"),
		Style:    tea.String("ROA"),
		// 介面 PATH
		Pathname: tea.String("/api/v1/clusters"),
		// 介面請求體內容格式
		ReqBodyType: tea.String("json"),
		// 介面響應體內容格式
		BodyType: tea.String("json"),
	}
	// 設定查詢參數
	queries := map[string]interface{}{}
	queries["name"] = tea.String("cluster-demo")
	request := &openapi.OpenApiRequest{
		Query: openapiutil.Query(queries),
	}
	// runtime options
	runtime := &util.RuntimeOptions{}
	// 傳回值為 Map 類型,可從 Map 中獲得三類資料:響應體 body、回應標頭 headers、HTTP 返回的狀態代碼 statusCode。
	response, err := client.CallApi(params, request, runtime)
	if err != nil {
		panic(err)
	}
	fmt.Println(response["body"])
}