ECS Go V2.0 SDK調用樣本 - Elastic Compute Service

本文以調用查詢一台或多台ECS執行個體的詳細資料（DescribeInstances）介面為例，為您介紹Go V2.0 SDK的安裝和使用。

前提條件

由於阿里雲帳號（主帳號）擁有資源的所有許可權，其AccessKey一旦泄露風險巨大，所以建議您使用滿足最小化許可權需求的RAM使用者的AccessKey。具體操作方式請參見建立AccessKey。
給RAM使用者授予操作Elastic Compute Service相關資源的許可權。本文提供的範例程式碼為查詢樣本，所以選擇AliyunECSReadonlyAccess系統權限原則，您在使用的時候可以根據業務需求進行自訂授權。
1. 使用自訂權限原則。
  關於如何建立自訂權限原則，請參見建立自訂權限原則和授權資訊。
  Elastic Compute Service依據最佳實務提供了一些自訂權限原則樣本，您可以參考這些樣本以快速建立符合自身業務需求的自訂權限原則，具體詳情請參見Elastic Compute Service自訂權限原則參考。
2. 使用系統權限原則。
  Elastic Compute Service支援的所有系統權限原則及其對應的許可權描述，請參見Elastic Compute Service系統權限原則參考。
在環境變數中配置AccessKey，具體操作步驟請參見在Linux、macOS和Windows系統配置環境變數。

安裝SDK

Go V2.0 SDK安裝方式請參見SDK中心。您可以直接複製下方提供的安裝命令在Terminal中執行，以完成ECS SDK的安裝：

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

使用SDK

1. 初始化用戶端

阿里雲SDK支援多種訪問憑據用於初始化用戶端，例如AccessKey和STS Token等，更多方式請參見管理訪問憑證。本樣本以通過AccessKey初始化用戶端為例。

package main

import (
	"os"

	openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
	ecs20140526 "github.com/alibabacloud-go/ecs-20140526/v4/client"
	"github.com/alibabacloud-go/tea/tea"
)

func CreateClient() (_result *ecs20140526.Client, _err error) {
	config := &openapi.Config{
		// 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
		AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
		// 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
		AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
	}
	// Endpoint 請參考 https://api.aliyun.com/product/Ecs
	config.Endpoint = tea.String("ecs-cn-hangzhou.aliyuncs.com")
	_result = &ecs20140526.Client{}
	_result, _err = ecs20140526.NewClient(config)
	return _result, _err
}

2. 構建介面的請求對象

在構建請求對象之前，請查看該介面的API文檔擷取參數資訊。

說明

請求對象命名規則：{API名稱}Request，例如DescribeInstances該介面的請求對象為DescribeInstancesRequest。

// 構造請求對象
describeInstancesRequest := &ecs20140526.DescribeInstancesRequest{
    RegionId: tea.String("cn-hangzhou"),
  }

3. 發起調用

通過用戶端調用OpenAPI時，支援設定運行時參數，例如逾時配置、代理配置等，更多資訊請查看進階配置。

說明

介面返回對象命名規則：{API名稱}Response，例如DescribeInstances該介面的返回對象為DescribeInstancesResponse。

// 設定運行時參數
runtime := &util.RuntimeOptions{}
// 調用 DescribeInstances 介面
response, _err := ecsClient.DescribeInstancesWithOptions(describeInstancesRequest, runtime)
if _err != nil {
	panic(_err)
}
fmt.Println(response.Body.String())

4. 異常處理

Go SDK將異常進行了細緻的分類，主要劃分為以下幾種error：

error：非業務報錯的error，比如SDK源檔案被修改導致的校正error，解析失敗導致的error等。
SDKError：在SDK的請求中主要以業務報錯為主的error。

建議採取合理的措施來處理異常，比如合理地傳播異常、記錄日誌、嘗試恢複等，以確保系統的健壯性和穩定性。

5. 完整樣本

package main

import (
	"fmt"
	"os"

	openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
	ecs20140526 "github.com/alibabacloud-go/ecs-20140526/v4/client"
	util "github.com/alibabacloud-go/tea-utils/v2/service"
	"github.com/alibabacloud-go/tea/tea"
)

func CreateClient() (_result *ecs20140526.Client, _err error) {
	config := &openapi.Config{
		// 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID。
		AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
		// 必填，請確保代碼運行環境設定了環境變數 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
		AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
	}
	// Endpoint 請參考 https://api.aliyun.com/product/Ecs
	config.Endpoint = tea.String("ecs-cn-hangzhou.aliyuncs.com")
	_result = &ecs20140526.Client{}
	_result, _err = ecs20140526.NewClient(config)
	return _result, _err
}

func main() {
	ecsClient, _err := CreateClient()
	if _err != nil {
		panic(_err)
	}
	// 構造請求對象
	describeInstancesRequest := &ecs20140526.DescribeInstancesRequest{
		RegionId: tea.String("cn-hangzhou"),
	}
	// 設定運行時參數
	runtime := &util.RuntimeOptions{}
	resp, tryErr := func() (response *ecs20140526.DescribeInstancesResponse, _e error) {
		defer func() {
			if r := tea.Recover(recover()); r != nil {
				_e = r
			}
		}()
		// 調用 DescribeInstances 介面
		response, _err := ecsClient.DescribeInstancesWithOptions(describeInstancesRequest, runtime)
		if _err != nil {
			return nil, _err
		}
		return response, nil
	}()

	if tryErr != nil {
		if sdkError, ok := tryErr.(*tea.SDKError); ok { // 使用類型斷言判斷 tryErr 是否為 *tea.SDKError 類型
			// 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
			fmt.Println(tea.StringValue(sdkError.Message))
			fmt.Println(tea.StringValue(sdkError.Code))
			fmt.Println(tea.StringValue(sdkError.Data))
		} else {
			// 此處僅做列印展示，請謹慎對待異常處理，在工程專案中切勿直接忽略異常。
			fmt.Println(tea.String(tryErr.Error()))
		}
	} else {
		fmt.Println(resp.Body)
	}
}

Elastic Compute Service：ECS Go V2.0 SDK調用樣本