sdk_doc

README

English | 简体中文

Huawei Cloud Go Software Development Kit (Go SDK)

The Huawei Cloud Go SDK allows you to easily work with Huawei Cloud services such as Elastic Compute Service (ECS) and Virtual Private Cloud (VPC) without the need to handle API related tasks.

This document introduces how to obtain and use Huawei Cloud Go SDK.

Requirements

• To use Huawei Cloud Go SDK, you must have Huawei Cloud account as well as the Access Key (AK) and Secret key (SK) of the Huawei Cloud account. You can create an AccessKey in the Huawei Cloud console. For more information, see My Credentials.

• To use Huawei Cloud Go SDK to access the APIs of specific service, please make sure you do have activated the service in Huawei Cloud console if needed.

• Huawei Cloud Go SDK requires go 1.14 or later, run command go version to check the version of Go.

Install Go SDK

Run the following command to install Huawei Cloud Go SDK:

# Install the library of Huawei Cloud Go SDK
go get github.com/huaweicloud/huaweicloud-sdk-go-v3

Code Example

• The following example shows how to query a list of VPCs in a specific region, you need to substitute your real {service} "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/{service}/{version}" for vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v2" in actual use, and initialize the client as {service}.New{Service}Client.
• Hard-coding ak and sk for authentication into the code has a great security risk. It is recommended to store the ciphertext in the profile or environment variables and decrypt it when used to ensure security.
• In this example, ak and sk are stored in environment variables. Please configure the environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK before running this example.

Simplified Demo

package main

import (
    "os"
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
	vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v2"
	vpcModel "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v2/model"
	vpcRegion "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v2/region"
)

func main() {
	// Configure authentication
    // Authentication can be configured through environment variables and other methods. Please refer to Chapter 2.4 Authentication Management
	auth := basic.NewCredentialsBuilder().
		WithAk(os.Getenv("HUAWEICLOUD_SDK_AK")).
		WithSk(os.Getenv("HUAWEICLOUD_SDK_SK")).
		Build()

	// Create a service client
	client := vpc.NewVpcClient(
		vpc.VpcClientBuilder().
			WithRegion(vpcRegion.ValueOf("cn-north-4")).
			WithCredential(auth).
			Build())

	// Send the request and get the response
	request := &vpcModel.ListVpcsRequest{}
	response, err := client.ListVpcs(request)
	if err == nil {
		fmt.Printf("%+v\n", response)
	} else {
		fmt.Println(err)
	}
}

Detailed Demo

package main

import (
	"context"
	"fmt"
	"os"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/config"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/httphandler"
	vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v2"
	vpcModel "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v2/model"
	vpcRegion "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v2/region"
	"net"
	"net/http"
)

func main() {
	// Configure authentication
	auth := basic.NewCredentialsBuilder().
        // Authentication can be configured through environment variables and other methods. Please refer to Chapter 2.4 Authentication Management
		WithAk(os.Getenv("HUAWEICLOUD_SDK_AK")).
		WithSk(os.Getenv("HUAWEICLOUD_SDK_SK")).
		// If ProjectId is not filled in, the SDK will automatically call the IAM service to query the project id corresponding to the region.
		WithProjectId("{your projectId string}").
		// Configure the SDK built-in IAM service endpoint, default is https://iam.myhuaweicloud.com
		WithIamEndpointOverride("https://iam.cn-north-4.myhuaweicloud.com").
		Build()

	// Use default configuration
	httpConfig := config.DefaultHttpConfig()
	// Configure whether to ignore the SSL certificate verification, default is false
	httpConfig.WithIgnoreSSLVerification(true)
	// Configure timeout as needed, default timeout is 120 seconds
	httpConfig.WithTimeout(120)
	// Configure proxy as needed
	proxy := config.NewProxy().
		// Replace the proxy schema, host and port in the example according to the actual situation
		WithSchema("http").
		WithHost("proxy.huaweicloud.com").
		WithPort(80).
		// Configure the username and password if the proxy requires authentication
		WithUsername(os.Getenv("PROXY_USERNAME")).
		WithPassword(os.Getenv("PROXY_PASSWORD"))
	httpConfig.WithProxy(proxy)
	// Configure how to create network connections as needed
	dialContext := func(ctx context.Context, network string, addr string) (net.Conn, error) {
		// You need to implement this function
	}
	httpConfig.WithDialContext(dialContext)
	// Configure HTTP handler for debugging, do not use in production environment
	requestHandler := func(request http.Request) {
		fmt.Println(request)
	}
	responseHandler := func(response http.Response) {
		fmt.Println(response)
	}
	httpHandler := httphandler.NewHttpHandler().AddRequestHandler(requestHandler).AddResponseHandler(responseHandler)
	httpConfig.WithHttpHandler(httpHandler)

	// Create a service client
	client := vpc.NewVpcClient(
		vpc.VpcClientBuilder().
			// Configure region, it will cause a panic if the region does not exist
			WithRegion(vpcRegion.ValueOf("cn-north-4")).
			// Configure authentication
			WithCredential(auth).
			// Configure HTTP
			WithHttpConfig(httpConfig).
			Build())

	// Create a request
	request := &vpcModel.ListVpcsRequest{}
	// Configure the number of records on each page
	limit := int32(1)
	request.Limit = &limit

	// Send the request and get the response
	response, err := client.ListVpcs(request)
	// Handle error and print response
	if err == nil {
		fmt.Printf("%+v\n", response)
	} else {
		fmt.Println(err)
	}
}

Online Debugging

API Explorer provides api retrieval and online debugging, supports full fast retrieval, visual debugging, help document viewing, and online consultation.

Changelog

Detailed changes for each released version are documented in the CHANGELOG.md.

User Manual 🔝

• 1. Client Configuration
  • 1.1 Default Configuration
  • 1.2 Network Proxy
  • 1.3 Timeout Configuration
  • 1.4 SSL Certification
  • 1.5 Custom Network Connection
  • 1.6 Custom HTTP Transport
• 2. Credentials Configuration
  • 2.1 Use Permanent AK&SK
  • 2.2 Use Temporary AK&SK
  • 2.3 Use IdpId&IdTokenFile
  • 2.4 Authentication Management
    • 2.4.1 Environment Variables
    • 2.4.2 Profile
    • 2.4.3 Metadata
    • 2.4.4 Provider Chain
• 3. Client Initialization
  • 3.1 Initialize client with specified Endpoint
  • 3.2 Initialize client with specified Region
  • 3.3 Custom Configuration
    • 3.3.1 IAM endpoint configuration
    • 3.3.2 Region configuration
• 4. Send Request and Handle response
  • 4.1 Exceptions
• 5. Troubleshooting
  • 5.1 Original HTTP Listener
• 6. Upload and download files
• 7. API Invoker
  • 7.1 Custom request headers
  • 7.2 Retry for request

1. Client Configuration 🔝

1.1 Default Configuration 🔝

import "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/config"

// Use default configuration
httpConfig := config.DefaultHttpConfig()

client := vpc.NewVpcClient(
    vpc.VpcClientBuilder().
    WithHttpConfig(httpConfig).
    Build())

1.2 Network Proxy 🔝

// Use proxy if needed
proxy := config.NewProxy().
    // Replace the proxy schema, host and port in the example according to the actual situation
    WithSchema("http").
    WithHost("proxy.huaweicloud.com").
    WithPort(80).
    // Configure the username and password if the proxy requires authentication
    // In this example, username and password are stored in environment variables. Please configure the environment variables PROXY_USERNAME and PROXY_PASSWORD before running this example.
    WithUsername(os.Getenv("PROXY_USERNAME")).
    WithPassword(os.Getenv("PROXY_PASSWORD"))
httpConfig := config.DefaultHttpConfig().WithProxy(proxy)

client := vpc.NewVpcClient(
    vpc.VpcClientBuilder().
    WithHttpConfig(httpConfig).
    Build())

1.3 Timeout Configuration 🔝

// The default timeout is 120 seconds, which can be adjusted as needed
httpConfig := config.DefaultHttpConfig().WithTimeout(120)

client := vpc.NewVpcClient(
    vpc.VpcClientBuilder().
    WithHttpConfig(httpConfig).
    Build())

1.4 SSL Certification 🔝

// Skip SSL certification checking while using https protocol if needed
httpConfig := config.DefaultHttpConfig().WithIgnoreSSLVerification(true)

client := vpc.NewVpcClient(
    vpc.VpcClientBuilder().
    WithHttpConfig(httpConfig).
    Build())

1.5 Custom Network Connection 🔝

// Config network connection dial function if needed
func DialContext(ctx context.Context, network string, addr string) (net.Conn, error) {
	return net.Dial(network, addr)
}
httpConfig := config.DefaultHttpConfig().WithDialContext(DialContext)

client := vpc.NewVpcClient(
    vpc.VpcClientBuilder().
    WithHttpConfig(httpConfig).
    Build())

1.6 Custom HTTP Transport 🔝

NOTE: The configuration has the highest priority.

Specifying the custom HTTP transport will invalidate the configurations 1.2 Network Proxy, 1.4 SSL Certification, 1.5 Custom Network Connection.

transport := &http.Transport{}
httpConfig := config.DefaultHttpConfig().WithHttpTransport(transport)

client := vpc.NewVpcClient(
    vpc.VpcClientBuilder().
    WithHttpConfig(httpConfig).
    Build())

2. Credentials Configuration 🔝

There are two types of Huawei Cloud services, regional services and global services.

Global services contain BSS, DevStar, EPS, IAM, RMS.

For regional services' authentication, projectId is required to initialize basic.NewCredentialsBuilder().

For global services' authentication, domainId is required to initialize global.NewCredentialsBuilder().

The following authentications are supported:

• permanent AK&SK
• temporary AK&SK + SecurityToken
• IdpId&IdTokenFile

2.1 Use Permanent AK&SK 🔝

Parameter description:

• ak is the access key ID for your account.
• sk is the secret access key for your account.
• projectId is the ID of your project depending on your region which you want to operate.
• domainId is the account ID of Huawei Cloud.

// Regional Services
ak := os.Getenv("HUAWEICLOUD_SDK_AK")
sk := os.Getenv("HUAWEICLOUD_SDK_SK")
projectId := "{your projectId string}"

basicCredentials := basic.NewCredentialsBuilder().
    WithAk(ak).
    WithSk(sk).
    WithProjectId(projectId).
    Build()

// Global Services
ak := os.Getenv("HUAWEICLOUD_SDK_AK")
sk := os.Getenv("HUAWEICLOUD_SDK_SK")
domainId := "{your domainId string}"

globalCredentials := global.NewCredentialsBuilder().
    WithAk(ak).
    WithSk(sk).
    WithDomainId(domainId).
    Build()

Notice:

• projectId/domainId supports automatic acquisition in version 0.0.26-beta or later, if you want to use this feature, you need to provide the ak and sk of your account and the id of the region, and then build your client instance with method WithRegion(), detailed example could refer to 3.2 Initialize client with specified Region .

2.2 Use Temporary AK&SK 🔝

It's required to obtain temporary AK&SK and security token first, which could be obtained through permanent AK&SK or through an agency.A temporary access key and securityToken are issued by the system to IAM users, and can be valid for 15 minutes to 24 hours.

• Obtaining a temporary access key and security token through token, you could refer to document: https://support.huaweicloud.com/en-us/api-iam/iam_04_0002.html . The API mentioned in the document above corresponds to the method of CreateTemporaryAccessKeyByToken in IAM SDK.

• Obtaining a temporary access key and security token through an agency, you could refer to document: https://support.huaweicloud.com/en-us/api-iam/iam_04_0101.html . The API mentioned in the document above corresponds to the method of CreateTemporaryAccessKeyByAgency in IAM SDK.

Parameter description:

• ak is the access key ID for your account.
• sk is the secret access key for your account.
• securityToken is the security token when using temporary AK/SK.
• projectId is the ID of your project depending on your region which you want to operate.
• domainId is the account ID of Huawei Cloud.

// Regional Services
ak := os.Getenv("HUAWEICLOUD_SDK_AK")
sk := os.Getenv("HUAWEICLOUD_SDK_SK")
securityToken := os.Getenv("HUAWEICLOUD_SDK_SECURITY_TOKEN")
projectId := "{your projectId string}"

basicCredentials := basic.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithSecurityToken(securityToken).
            WithProjectId(projectId).
            Build()

// Global Services
ak := os.Getenv("HUAWEICLOUD_SDK_AK")
sk := os.Getenv("HUAWEICLOUD_SDK_SK")
securityToken := os.Getenv("HUAWEICLOUD_SDK_SECURITY_TOKEN")
domainId := "{your domainId string}"

globalCredentials := global.NewCredentialsBuilder().
            WithAk(ak).
            WithSk(sk).
            WithSecurityToken(securityToken).
            WithDomainId(domainId).
            Build()

In the following two cases, the temporary AK/SK and securitytoken will be obtained from the metadata of the instance:

1. basic.Credentials or global.Credentials were not explicitly specified when creating the client.
2. AK/SK was not explicitly specified when creating basic.Credentials or global.Credentials.

Refer to the Obtaining Metadata for more information.

// Regional Services
basicAuth := basic.NewCredentialsBuilder().WithProjectId(projectId).Build()

// Global Services
globalAuth := global.NewCredentialsBuilder().WithDomainId(domainId).Build()

2.3 Use IdpId&IdTokenFile 🔝

Obtain a federated identity authentication token using an OpenID Connect ID token, refer to the Obtaining a Token with an OpenID Connect ID Token

Parameter description:

• idpId Identity provider ID.
• idTokenFile Id token file path. Id token is constructed by the enterprise IdP to carry the identity information of federated users.
• projectId is the ID of your project depending on your region which you want to operate.
• domainId is the account ID of Huawei Cloud.

import (
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
)

// Regional service
basicAuth := basic.NewCredentialsBuilder().
	WithIdpId(idpId).
	WithIdTokenFile(idTokenFile).
	WithProjectId(projectId).
	Build()

// Global service
globalAuth := global.NewCredentialsBuilder().
	WithIdpId(idpId).
	WithIdTokenFile(idTokenFile).
	WithDomainId(domainId).
	Build()

2.4 Authentication Management 🔝

Getting Authentication from providers is supported since v0.0.96

Regional services use BasicCredentialXxxProvider, Global services use GlobalCredentialXxxProvider

2.4.1 Environment Variables 🔝

AK/SK Auth

Environment Variables	Notice
HUAWEICLOUD_SDK_AK	Required, AccessKey
HUAWEICLOUD_SDK_SK	Required, SecretKey
HUAWEICLOUD_SDK_SECURITY_TOKEN	Optional, this parameter needs to be specified when using temporary ak/sk
HUAWEICLOUD_SDK_PROJECT_ID	Optional, used for regional services, required in multi-ProjectId scenarios
HUAWEICLOUD_SDK_DOMAIN_ID	Optional, used for global services

Configure environment variables:

// Linux
export HUAWEICLOUD_SDK_AK=YOUR_AK
export HUAWEICLOUD_SDK_SK=YOUR_SK

// Windows
set HUAWEICLOUD_SDK_AK=YOUR_AK
set HUAWEICLOUD_SDK_SK=YOUR_SK

Get the credentials from configured environment variables:

import (
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/provider"
)

// basic
basicProvider := provider.BasicCredentialEnvProvider()
basicCred, err := basicProvider.GetCredentials()

// global
globalProvider := provider.GlobalCredentialEnvProvider()
globalCred, err := globalProvider.GetCredentials()

IdpId/IdTokenFile Auth

Environment Variables	Notice
HUAWEICLOUD_SDK_IDP_ID	Required, identity provider Id
HUAWEICLOUD_SDK_ID_TOKEN_FILE	Required, id token file path
HUAWEICLOUD_SDK_PROJECT_ID	For basic credentials, this parameter is required
HUAWEICLOUD_SDK_DOMAIN_ID	For global credentials, this parameter is required

Configure environment variables:

// Linux
export HUAWEICLOUD_SDK_IDP_ID=YOUR_IDP_ID
export HUAWEICLOUD_SDK_ID_TOKEN_FILE=/some_path/your_token_file
export HUAWEICLOUD_SDK_PROJECT_ID=YOUR_PROJECT_ID // For basic credentials, this parameter is required
export HUAWEICLOUD_SDK_DOMAIN_ID=YOUR_DOMAIN_ID // For global credentials, this parameter is required

// Windows
set HUAWEICLOUD_SDK_IDP_ID=YOUR_IDP_ID
set HUAWEICLOUD_SDK_ID_TOKEN_FILE=/some_path/your_token_file
set HUAWEICLOUD_SDK_PROJECT_ID=YOUR_PROJECT_ID // For basic credentials, this parameter is required
set HUAWEICLOUD_SDK_DOMAIN_ID=YOUR_DOMAIN_ID // For global credentials, this parameter is required

Get the credentials from configured environment variables:

import (
    "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/provider"
)

// basic
basicProvider := provider.BasicCredentialEnvProvider()
basicCred, err := basicProvider.GetCredentials()

// global
globalProvider := provider.GlobalCredentialEnvProvider()
globalCred, err := globalProvider.GetCredentials()

2.4.2 Profile 🔝

The profile will be read from the user's home directory by default, linux~/.huaweicloud/credentials,windowsC:\Users\USER_NAME\.huaweicloud\credentials, the path to the profile can be modified by configuring the environment variable HUAWEICLOUD_SDK_CREDENTIALS_FILE

AK/SK Auth

Configuration Parameters	Notice
ak	Required, AccessKey
sk	Required, SecretKey
security_token	Optional, this parameter needs to be specified when using temporary ak/sk
project_id	Optional, used for regional services, required in multi-ProjectId scenarios
domain_id	Optional, used for global services
iam_endpoint	optional, endpoint for authentication, default is https://iam.myhuaweicloud.com

The content of the profile is as follows:

[basic]
ak = your_ak
sk = your_sk

[global]
ak = your_ak
sk = your_sk

Get the credentials from profile:

import (
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/provider"
)

// basic
basicProvider := provider.BasicCredentialProfileProvider()
basicCred, err := basicProvider.GetCredentials()

// global
globalProvider := provider.GlobalCredentialProfileProvider()
globalCred, err := globalProvider.GetCredentials()

IdpId/IdTokenFile Auth

Configuration Parameters	Notice
idp_id	Required, identity provider Id
id_token_file	Required, id token file path
project_id	For basic credentials, this parameter is required
domain_id	For global credentials, this parameter is required
iam_endpoint	optional, endpoint for authentication, default is https://iam.myhuaweicloud.com

The content of the profile is as follows:

[basic]
idp_id = your_idp_id
id_token_file = /some_path/your_token_file
project_id = your_project_id

[global]
idp_id = your_idp_id
id_token_file = /some_path/your_token_file
domainId = your_domain_id

Get the credentials from profile:

import (
    "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/provider"
)

// basic
basicProvider := provider.BasicCredentialProfileProvider()
basicCred, err := basicProvider.GetCredentials()

// global
globalProvider := provider.GlobalCredentialProfileProvider()
globalCred, err := globalProvider.GetCredentials()

2.4.3 Metadata 🔝

Get temporary AK/SK and securitytoken from instance's metadata. Refer to the Obtaining Metadata for more information.

Manually obtain authentication from instance metadata:

import (
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/provider"
)

// basic
basicProvider := provider.BasicCredentialMetadataProvider()
basicCred, err := basicProvider.GetCredentials()

// global
globalProvider := provider.GlobalCredentialMetadataProvider()
globalCred, err := globalProvider.GetCredentials()

2.4.4 Provider Chain 🔝

When creating a service client without credentials, try to load authentication in the order Environment Variables -> Profile -> Metadata

Get authentication from provider chain:

import (
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/provider"
)

// basic
basicChain := provider.BasicCredentialProviderChain()
basicCred, err := basicChain.GetCredentials()

// global
globalChain := provider.GlobalCredentialProviderChain()
globalCred, err := globalChain.GetCredentials()

Custom credentials provider chain is supported:

import (
    "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/provider"
)

providers := []provider.ICredentialProvider{
    provider.BasicCredentialMetadataProvider(),
    provider.BasicCredentialProfileProvider(),
}
chain := provider.NewCredentialProviderChain(providers)
cred, err := chain.GetCredentials()

3. Client Initialization 🔝

There are two ways to initialize the {Service}Client, you could choose one you preferred.

3.1 Initialize the {Service}Client with specified Endpoint 🔝

// Specify the endpoint, take the endpoint of VPC service in region of cn-north-4 for example
endpoint := "https://vpc.cn-north-4.myhuaweicloud.com"

// Initialize the credentials, you should provide projectId or domainId in this way, take initializing BasicCredentials for example
basicAuth := basic.NewCredentialsBuilder().
    WithAk(os.Getenv("HUAWEICLOUD_SDK_AK")).
    WithSk(os.Getenv("HUAWEICLOUD_SDK_SK")).
    WithProjectId("{your projectId string}").
    Build()

// Initialize specified New{Service}Client, take initializing the regional service VPC's VpcClient for example
client := vpc.NewVpcClient(
    vpc.VpcClientBuilder().
        WithEndpoint(endpoint).
        WithCredential(basicCredentials).
        WithHttpConfig(config.DefaultHttpConfig()).  
        Build())

where:

• endpoint varies with services and regions, see Regions and Endpoints to obtain correct endpoint.

• When you meet some trouble in getting projectId using the specified region way, you could use this way instead.

3.2 Initialize the {Service}Client with specified Region (Recommended) 🔝

import (
    // dependency for region module
    "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/iam/v3/region"
    "os"
)

// Initialize the credentials, projectId or domainId could be unassigned in this situation, take initializing GlobalCredentials for example
globalCredentials := global.NewCredentialsBuilder().
    WithAk(os.Getenv("HUAWEICLOUD_SDK_AK")).
    WithSk(os.Getenv("HUAWEICLOUD_SDK_SK")).
    // domainId could be unassigned in this situation
    Build()

// Initialize specified New{Service}Client, take initializing the global service IAM's NewIamClient for example
client := iam.NewIamClient(
    iam.IamClientBuilder().
        WithRegion(region.CN_NORTH_4).
        WithCredential(globalCredentials).
        WithHttpConfig(config.DefaultHttpConfig()).  
        Build())

Notice:

• If you use region to initialize {Service}Client, projectId/domainId supports automatic acquisition, you don't need to configure it when initializing Credentials.

• Multiple ProjectId situation is not supported.

• Supported region list: af-south-1, ap-southeast-1, ap-southeast-2, ap-southeast-3, cn-east-2, cn-east-3, cn-north-1, cn-north-4, cn-south-1, cn-southwest-2, ru-northwest-2. You may get exception such as Unsupported regionId if your region don't in the list above.

Comparison of the two ways:

Initialization	Advantages	Disadvantage
Specified Endpoint	The API can be invoked successfully once it has been published in the environment.	You need to prepare projectId and endpoint yourself.
Specified Region	No need for projectId and endpoint, it supports automatic acquisition if you configure it in the right way.	The supported services and regions are limited.

3.3 Custom Configuration 🔝

Notice: Supported since v0.0.92

3.3.1 IAM endpoint configuration 🔝

Automatically acquiring projectId/domainId will invoke the KeystoneListProjects /KeystoneListAuthDomains interface of IAM service. The default iam endpoint is https://iam.myhuaweicloud.com, European station users need to specify the endpoint as https://iam.eu-west-101.myhuaweicloud.eu, you can modify the endpoint in the following two ways:

3.3.1.1 Global scope 🔝

This configuration takes effect globally, specified by environment variable HUAWEICLOUD_SDK_IAM_ENDPOINT

//linux
export HUAWEICLOUD_SDK_IAM_ENDPOINT=https://iam.cn-north-4.myhuaweicloud.com

//windows
set HUAWEICLOUD_SDK_IAM_ENDPOINT=https://iam.cn-north-4.myhuaweicloud.com

3.3.1.2 Credentials scope 🔝

This configuration is only valid for a credential, and it will override the global configuration

import "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"

iamEndpoint := "https://iam.cn-north-4.myhuaweicloud.com"
cred := basic.NewCredentialsBuilder().
			WithAk(os.Getenv("HUAWEICLOUD_SDK_AK")).
			WithSk(os.Getenv("HUAWEICLOUD_SDK_SK")).
			WithIamEndpointOverride(iamEndpoint).
			Build()

3.3.2 Region configuration 🔝

3.3.2.1 Code 🔝

import (
    vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ecs/v2"
    "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/region"
)

// Create a region with custom region id and endpoint
reg := region.NewRegion("cn-north-9", "https://ecs.cn-north-9.myhuaweicloud.com")

client := ecs.NewEcsClient(
    ecs.EcsClientBuilder().
    WithRegion(reg).
    WithCredential(auth).
    Build())

3.3.2.2 Environment variable 🔝

Specified by environment variable, the format is HUAWEICLOUD_SDK_REGION_{SERVICE_NAME}_{REGION_ID}={endpoint}

Notice: the name of environment variable is UPPER-CASE, replacing hyphens with underscores.

// Take ECS and IoTDA services as examples

// linux
export HUAWEICLOUD_SDK_REGION_ECS_CN_NORTH_9=https://ecs.cn-north-9.myhuaweicloud.com
export HUAWEICLOUD_SDK_REGION_IOTDA_AP_SOUTHEAST_1=https://iotda.ap-southwest-1.myhuaweicloud.com

// windows
set HUAWEICLOUD_SDK_REGION_ECS_CN_NORTH_9=https://ecs.cn-north-9.myhuaweicloud.com
set HUAWEICLOUD_SDK_REGION_IOTDA_AP_SOUTHEAST_1=https://iotda.ap-southwest-1.myhuaweicloud.com

A region corresponding to multiple endpoints is supported since v0.1.60, if the main endpoint cannot be connected, it will automatically switch to the backup endpoint.

The format is HUAWEICLOUD_SDK_REGION_{SERVICE_NAME}_{REGION_ID}={endpoint1},{endpoint2}, separate multiple endpoints with commas, such as HUAWEICLOUD_SDK_REGION_ECS_CN_NORTH_9=https://ecs.cn-north-9.myhuaweicloud.com,https://ecs.cn-north-9.myhuaweicloud.cn

3.3.2.3 Profile 🔝

The profile will be read from the user's home directory by default, linux~/.huaweicloud/regions.yaml, windowsC:\Users\USER_NAME\.huaweicloud\regions.yaml, the default file may not exist, but if the file exists and the content format is incorrect, an exception will be thrown for parsing errors.

The path to the profile can be modified by configuring the environment variable HUAWEICLOUD_SDK_REGIONS_FILE, like HUAWEICLOUD_SDK_REGIONS_FILE=/tmp/my_regions.yml

The file content format is as follows:

# Service name is case-insensitive
ECS:
  - id: 'cn-north-1'
    endpoint: 'https://ecs.cn-north-1.myhuaweicloud.com'
  - id: 'cn-north-9'
    endpoint: 'https://ecs.cn-north-9.myhuaweicloud.com'
IoTDA:
  - id: 'ap-southwest-1'
    endpoint: 'https://iotda.ap-southwest-1.myhuaweicloud.com'

A region corresponding to multiple endpoints is supported since v0.1.62, if the main endpoint cannot be connected, it will automatically switch to the backup endpoint.

ECS:
  - id: 'cn-north-1'
    endpoints:
      - 'https://ecs.cn-north-1.myhuaweicloud.com'
      - 'https://ecs.cn-north-1.myhuaweicloud.cn'

3.3.2.4 Region supply chain 🔝

The default lookup order is environment variables -> profile -> region defined in SDK of method region.ValueOf(regionId), if the region is not found in the above ways, an exception will be thrown.

import "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ecs/v2/region"

var (
	region1 = region.ValueOf("cn-north-1")
	region2 = region.ValueOf("cn-north-9")
)

4. Send Requests and Handle Responses 🔝

// send a request and print response, take interface of ListVpcs for example
limit := int32(1)
request := &model.ListVpcsRequest{
    Limit: &limit,
}

response, err := client.ListVpcs(request)
if err == nil {
    fmt.Printf("%+v\n\n", response.Vpcs)
} else {
    fmt.Println(err)
}

4.1 Exceptions 🔝

Level 1	Notice
ServiceResponseError	service response error
url.Error	connect endpoint error

response, err := client.ListVpcs(request)
if err == nil {
    fmt.Printf("%+v\n\n", response.Vpcs)
} else {
    fmt.Println(err)
}

5. Troubleshooting 🔝

5.1 Original HTTP Listener 🔝

In some situation, you may need to debug your http requests, original http request and response information will be needed. The SDK provides a listener function to obtain the original encrypted http request and response information.

⚠ Warning: The original http log information is used in debugging stage only, please do not print the original http header or body in the production environment. This log information is not encrypted and contains sensitive data such as the password of your ECS virtual machine, or the password of your IAM user account, etc. When the response body is binary content, the body will be printed as "***" without detailed information.

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/config"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/httphandler"
	vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v2"
	"net/http"
)

func RequestHandler(request http.Request) {
	fmt.Println(request)
}

func ResponseHandler(response http.Response) {
	fmt.Println(response)
}

handler := httphandler.NewHttpHandler().
	AddRequestHandler(RequestHandler).
	AddResponseHandler(ResponseHandler)
httpConfig := config.DefaultHttpConfig().WithHttpHandler(handler)

client := vpc.NewVpcClient(
	vpc.VpcClientBuilder().
		WithHttpConfig(httpConfig).
		Build())

6. Upload and download files 🔝

Take the interface CreateImageWatermark of the service Data Security Center as an example, this interface needs to upload an image file and return the watermarked image file stream:

package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/def"
	dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model"
	"os"
)

func createImageWatermark(client *dsc.DscClient) {
	
	// Open the file.
	file, err := os.Open("demo.jpg")
	if err != nil {
		fmt.Println(err)
		return
	}
	defer file.Close()

	body := &model.CreateImageWatermarkRequestBody{
		File:           def.NewFilePart(file),
		BlindWatermark: def.NewMultiPart("test_watermark"),
	}

	request := &model.CreateImageWatermarkRequest{Body: body}
	response, err := client.CreateImageWatermark(request)
	if err == nil {
		fmt.Printf("%+v\n", response)
	} else {
		fmt.Println(err)
		return
	}

	// Download the file.
	result, err := os.Create("result.jpg")
	if err != nil {
		fmt.Println(err)
		return
	}
	response.Consume(result)

}

func main() {
	ak := os.Getenv("HUAWEICLOUD_SDK_AK")
	sk := os.Getenv("HUAWEICLOUD_SDK_SK")
	endpoint := "{your endpoint string}"
	projectId := "{your project id}"

	credentials := basic.NewCredentialsBuilder().
		WithAk(ak).
		WithSk(sk).
		WithProjectId(projectId).
		Build()

	client := dsc.NewDscClient(
		dsc.DscClientBuilder().
			WithEndpoint(endpoint).
			WithCredential(credentials).
			Build())

	createImageWatermark(client)
}

7. API Invoker 🔝

7.1 Custom request headers 🔝

You can flexibly configure request headers as needed. Do not specify common request headers such as Host, Authorization, User-Agent, Content-Type unless necessary, as this may cause the errors.

client := vpc.NewVpcClient(
	vpc.VpcClientBuilder().
		WithEndpoint("<input your endpoint>").
		WithCredential(
			basic.NewCredentialsBuilder().
				WithAk(os.Getenv("HUAWEICLOUD_SDK_AK")).
				WithSk(os.Getenv("HUAWEICLOUD_SDK_SK")).
				WithProjectId("<input your project id>").
				Build()).
		Build())

request := &model.ListVpcsRequest{}
response, err := client.ListVpcsInvoker(request).
	// custom request headers
	AddHeader(map[string]string{"key1": "value1", "key2": "value2"}).
	Invoke()

if err == nil {
	fmt.Printf("%+v\n", response)
} else {
	fmt.Printf("%+v\n", err)
}

7.2 Retry for request 🔝

When a request encounters a network exception or flow control on the interface, the request needs to be retried. The Go SDK provides the retry method for our users which could be used to the requests of GET HTTP method. If you want to use the retry method, the following parameters are required:

• maxRetryTimes: the max retry times
• retryCondition: a function, which determine the condition of when to retry
• backoffStrategy: calculate the wait duration before next retry

Take the interface ListVpcs of VPC service for example, assume the request would retry at most 3 times, retry when service responses an error, the code would be like the following:

// initialize the client
client := vpc.NewVpcClient(
	vpc.VpcClientBuilder().
		WithEndpoint("<input your endpoint>").
		WithCredential(
			basic.NewCredentialsBuilder().
				WithAk(os.Getenv("HUAWEICLOUD_SDK_AK")).
				WithSk(os.Getenv("HUAWEICLOUD_SDK_SK")).
				WithProjectId("<input your project id>").
				Build()).
		Build())

// initialize the request
request := &model.ListVpcsRequest{}

// send the requet and retry when service responses an error
response, err := client.ListVpcsInvoker(request).WithRetry(3, func(i interface{}, err error) bool {
	return err != nil
}, new(retry.None)).Invoke()

if err == nil {
	fmt.Printf("%+v\n", response)
} else {
	fmt.Printf("%+v\n", err)
}

Documentation

Overview

Package sdk_doc created for dependence ensure.