通過IDE使用阿里云Go SDK
本文以在Windows操作系統上,通過VS Code使用阿里云SDK為例,幫助您了解如何快速使用阿里云Go SDK。
前提條件
已安裝Go,如您未安裝請參見在Windows安裝Go。
已安裝VS Code,如果您未安裝請參見在Windows搭建Go開發環境。
使用 SDK
使用OpenAPI門戶提供的代碼示例工程
可能會存在OpenAPI無法下載代碼示例工程的情況,您可以查看在已有項目中使用SDK的介紹。
進入OpenAPI門戶的API調試頁面,選擇云產品和接口。例如我們以調用云服務器ECS的DescribeRegions接口為例,可在搜索欄中填入DescribeRegions,在搜索結果中單擊API名稱進入API調試頁面。
在參數配置頁簽中填寫需要的參數信息。填寫時請參考右側文檔頁簽,充分了解接口的說明和注意事項(尤其是費用相關信息),以及各參數的具體含義和使用方法。
如DescribeRegions接口支持傳入三個參數:
參數名
是否必填
說明
InstanceChargeType
非必填
不同的實例計費方式可能支持的地域不同。默認值為PrePaid。
ResourceType
非必填
不同的資源類型可能支持的地域不同。默認值為instance。
AcceptLanguage
非必填
設置返回結果的語言。默認值為zh-CN。
在右側的SDK示例頁面,選擇語言,單擊下載完整工程按鈕,下載SDK完整工程至本地并解壓。
打開VS Code,在菜單欄單擊File->Open Folder,選擇解壓后的文件夾。
在VS Code菜單欄中單擊Terminal->New Terminal,將會在底部展示TERMINAL窗口。
在Terminal中執行以下命令來整理和更新當前模塊的依賴關系。
go mod tidy
運行示例代碼。在Terminal中執行以下命令,運行main包下的示例代碼。
go run ./main
查看運行結果。在Terminal中按下
Ctrl+F
,搜索statusCode
,如果看到"statusCode":200
表示調用成功。
在已有項目中使用SDK
打開VS Code,在VS Code菜單欄,單擊File->Open Folder,新建一個項目文件夾或者選擇一個已有的項目文件夾。例如文件夾名稱為gosdkproject,然后選擇該文件夾。
在VS Code菜單欄中單擊Terminal->New Terminal,將會在底部展示Terminal窗口。并在Terminal中執行
go mod init gosdkprojects
進行Go項目初始化。獲取SDK。
訪問SDK中心,選擇您想要使用的 SDK的云產品,這里以云服務器ECS為例。SDK版本選擇V2.0,語言選擇Go。
安裝SDK。
復制安裝命令到Terminal中,然后按下回車執行。
創建一個.go文件。在項目名稱右邊,單擊New File...,填寫文件名稱,例如ecsDescribeRegions.go。
初始化客戶端。
如您想調用ECS的API,必須先對ECS的客戶端做初始化。
重要初始化客戶端時需要使用AccessKey完成身份驗證,請提前獲取AccessKey。獲取方法請參見創建AccessKey。
獲取RAM用戶的AccessKey之后,還需要在環境變量中設置AccessKey,具體操作步驟請參見在Linux、macOS和Windows系統配置環境變量。
endpoint如何設置請參見服務接入點。
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" ) // CreateClient 函數初始化并返回一個 ECS Client。 // 該函數不接受參數,但需要確保環境變量 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET 已經設置。 // return *ecs20140526.Client // return error:如果在創建客戶端過程中遇到任何錯誤,則返回非 nil 錯誤對象。 func CreateClient() (_result *ecs20140526.Client, _err error) { // 初始化 openapi.Config 對象,用于配置 ECS 客戶端。 config := &openapi.Config{ AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")), AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")), Endpoint: tea.String("ecs.cn-hangzhou.aliyuncs.com"), } // 使用配置信息創建并返回一個 ECS 客戶端實例。 return ecs20140526.NewClient(config) }
調用API。在調用OpenAPI之前,您需要先了解OpenAPI的詳細信息,請查看API文檔,以調用ECS的DescribeRegions為例。
說明每個API都有獨立的請求對象,命名規則為${API名稱}${Request},例如DescribeRegionsRequest。
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" ) // CreateClient 函數初始化并返回一個 ECS Client。 // 該函數不接受參數,但需要確保環境變量 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET 已經設置。 // return *ecs20140526.Client // return error:如果在創建客戶端過程中遇到任何錯誤,則返回非 nil 錯誤對象。 func CreateClient() (_result *ecs20140526.Client, _err error) { // 初始化 openapi.Config 對象,用于配置 ECS 客戶端。 config := &openapi.Config{ AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")), AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")), Endpoint: tea.String("ecs.cn-hangzhou.aliyuncs.com"), } // 使用配置信息創建并返回一個 ECS 客戶端實例。 return ecs20140526.NewClient(config) } // InvokeApi 函數用于調用ECS的DescribeRegions接口,查詢可用的地域信息。 // // 返回值: // _result: 返回一個*ecs20140526.DescribeRegionsResponse類型的指針,包含查詢到的地域信息。 // _err: 返回一個error類型的錯誤信息,如果調用過程中發生錯誤,則該值非空。 func InvokeApi()(_result *ecs20140526.DescribeRegionsResponse, _err error) { // 創建ECS客戶端 client, _err := CreateClient() if _err != nil { // 如果創建客戶端過程中出現錯誤,直接返回錯誤信息 return _result, _err } // 創建DescribeRegions請求 describeRegionsRequest := &ecs20140526.DescribeRegionsRequest{} // 發起DescribeRegions請求,并返回結果 return client.DescribeRegions(describeRegionsRequest) }
異常處理。
阿里云Go SDK通過返回報錯信息來處理異常,詳情請參見異常處理。但是在某些不可預料的情況下,可能需要使用
panic
和recover
來處理異常。Go語言中使用panic
來處理異常時,會立即停止當前函數的執行。所以一般還會搭配defer一起使用,在defer
中通過recover
函數捕獲當前的panic
,使正常執行流程恢復。因此,合理使用panic
,defer
和recover
可以幫助構建更健壯的錯誤處理邏輯,尤其是在處理可能引起程序崩潰的嚴重錯誤時。package main import ( "fmt" "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" ) // CreateClient 函數初始化并返回一個 ECS Client。 // 該函數不接受參數,但需要確保環境變量 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET 已經設置。 // return *ecs20140526.Client // return error:如果在創建客戶端過程中遇到任何錯誤,則返回非 nil 錯誤對象。 func CreateClient() (_result *ecs20140526.Client, _err error) { // 初始化 openapi.Config 對象,用于配置 ECS 客戶端。 config := &openapi.Config{ AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")), AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")), Endpoint: tea.String("ecs.cn-hangzhou.aliyuncs.com"), } // 使用配置信息創建并返回一個 ECS 客戶端實例。 return ecs20140526.NewClient(config) } // InvokeApi 函數用于調用ECS的DescribeRegions接口,查詢可用的地域信息。 // // 返回值: // _result: 返回一個*ecs20140526.DescribeRegionsResponse類型的指針,包含查詢到的地域信息。 // _err: 返回一個error類型的錯誤信息,如果調用過程中發生錯誤,則該值非空。 func InvokeApi() (_result *ecs20140526.DescribeRegionsResponse, _err error) { // 創建ECS客戶端 client, _err := CreateClient() if _err != nil { // 如果創建客戶端過程中出現錯誤,直接返回錯誤信息 return _result, _err } // 創建DescribeRegions請求 describeRegionsRequest := &ecs20140526.DescribeRegionsRequest{} // 發起DescribeRegions請求,并返回結果 return client.DescribeRegions(describeRegionsRequest) } // 該函數主要實現了通過調用API獲取地域信息,并在發生異常時進行恢復和處理。 func main() { // 在深度遞歸或無法預料的報錯等場景下,才推薦使用defer defer func() { if err := tea.Recover(recover()); err != nil { // 當捕獲到異常時,根據異常類型進行處理 if sdkError, ok := err.(*tea.SDKError); ok { // 打印SDK錯誤信息、錯誤碼和相關數據 fmt.Println(tea.StringValue(sdkError.Message)) fmt.Println(tea.StringValue(sdkError.Code)) fmt.Println(tea.StringValue(sdkError.Data)) } else { // 打印其他類型錯誤信息 fmt.Println(err) } } }() // 調用API獲取結果 result, _ := InvokeApi() // 遍歷并打印結果中的地域信息 for _, region := range result.Body.Regions.Region { fmt.Println("regionId: " + tea.StringValue(region.RegionId)) } // 打印RequestId fmt.Println("RequestId: " + tea.StringValue(result.Body.RequestId)) }
在TERMINAL中使用
go run
命令運行。