Integrate the SDK

1. Log on to the SDK Center and select the product for the API you want to call, such as Short Message Service (SMS).

2. On the Installation page, for SDK Generation, select V2.0, and for All Languages, select Go. Then, on the Quick Start tab, you can find the SDK installation method for Short Message Service (SMS).

Special scenario: Configure the Advance API for file uploads

Some cloud products (such as Image Search and Visual Intelligence API) require the Advance API for local file uploads. This API accepts a file stream, temporarily stores the file in Alibaba Cloud OSS (default region: cn-shanghai), and processes it. This example uses the DetectBodyCount API from the Visual Intelligence API.

1. 1. Initialize the request client

   Set both RegionId and Endpoint. RegionId specifies the OSS region for temporary file storage. Omitting RegionId may cause timeouts if the product and OSS are in different regions.

   import (
     "os"
   
     openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
     facebody20191230 "github.com/alibabacloud-go/facebody-20191230/v5/client"
     "github.com/alibabacloud-go/tea/tea"
   )
   
   func CreateClient() (_result *facebody20191230.Client, _err error) {
     config := &openapi.Config{
       // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
       AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
       // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
       AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
     }
     // The endpoint and regionId must be set to the same region.
     config.RegionId = tea.String("cn-shanghai")
     config.Endpoint = tea.String("facebody.cn-shanghai.aliyuncs.com")
     _result, _err = facebody20191230.NewClient(config)
     return _result, _err
   }

2. Create an instance of the AdvanceRequest struct

   Use the AdvanceRequest struct (named <APIName>AdvanceRequest) to pass the file stream. The file stream parameter has type io.Reader.

   // Replace with the file path.
   filePath := `<FILE_PATH>`
   // Open the file and create a stream.
   file, err := os.Open(filePath)
   if err != nil {
     return fmt.Errorf("Failed to open file: %v", err)
   }
   defer file.Close() // Close the file.
   // Create an AdvanceRequest struct instance.
   detectBodyCountAdvanceRequest := &facebody20191230.DetectBodyCountAdvanceRequest{
     ImageURLObject: file,
   }

3. Send a request

   Call <APIName>Advance with a pointer to the AdvanceRequest struct.

   // You need to add util "github.com/alibabacloud-go/tea-utils/v2/service" to the import.
   
   func _main() (response *facebody20191230.DetectBodyCountResponse, _err error) {
     client, _err := CreateClient()
     if _err != nil {
       return nil, _err
     }
   
     // Replace with the file path.
     filePath := `<FILE_PATH>`
     // Open the file and create a stream.
     file, err := os.Open(filePath)
     if err != nil {
       return nil, fmt.Errorf("Failed to open file: %v", err)
     }
     defer file.Close() // Close the file.
     // Create a request object.
     detectBodyCountAdvanceRequest := &facebody20191230.DetectBodyCountAdvanceRequest{
       ImageURLObject: file,
     }
     runtime := &util.RuntimeOptions{}
     // Send the request.
     response, _err = client.DetectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime)
   
     if _err != nil {
       return nil, _err
     }
     return response, nil
   }

package main

import (
  "fmt"
  "os"

  openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  facebody20191230 "github.com/alibabacloud-go/facebody-20191230/v5/client"
  util "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)

func CreateClient() (_result *facebody20191230.Client, _err error) {

  config := &openapi.Config{
    // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_ID environment variable is set.
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set.
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  config.RegionId = tea.String("cn-shanghai")
  config.Endpoint = tea.String("facebody.cn-shanghai.aliyuncs.com")
  _result, _err = facebody20191230.NewClient(config)
  return _result, _err
}

func _main() (response *facebody20191230.DetectBodyCountResponse, _err error) {
  client, _err := CreateClient()
  if _err != nil {
    return nil, _err
  }

  // Replace with the file path.
  filePath := `<FILE_PATH>`
  // Open the file and create a stream.
  file, err := os.Open(filePath)
  if err != nil {
    return nil, fmt.Errorf("Failed to open file: %v", err)
  }
  defer file.Close() // Close the file.
  // Create a request object.
  detectBodyCountAdvanceRequest := &facebody20191230.DetectBodyCountAdvanceRequest{
    ImageURLObject: file,
  }
  runtime := &util.RuntimeOptions{}
  // Send the request.
  response, _err = client.DetectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime)

  if _err != nil {
    return nil, _err
  }
  return response, nil
}
func main() {
  response, err := _main()
  if err != nil {
    panic(err)
  }
  fmt.Println(response)
}

FAQ

1. The error message "You are not authorized to perform this operation" is returned when I call an OpenAPI.

   Cause and solution

   Cause: The Resource Access Management (RAM) user that corresponds to your AccessKey does not have the required permissions to call the API.

   Solution: Grant the required OpenAPI permissions to the RAM user. Manage RAM user permissions.

   For example, if this error occurs when calling the SendSms API, create a custom policy and grant it to the RAM user:

   {
     "Version": "1",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": "dysms:SendSms",
         "Resource": "*"
       }
     ]
   }

2. The error message "SDKError: Message: Post "https://ecs-cn-XX.aliyuncs.com": dial tcp: lookup ecs-cn-XX.aliyuncs.com: no such host" is returned when I call an OpenAPI.

   Cause and solution

   Cause: The Endpoint that you specified during client initialization is not supported by the OpenAPI that you are calling.

   Solution: Modify the Endpoint and retry. Configure endpoints.

3. The error message "SDKError: StatusCode: 404 Code: InvalidAccessKeyId.NotFound Message: code: 404, Specified access key is not found." is returned when I call an OpenAPI.

   Cause and solution

   Cause: The AccessKey was not passed correctly.

   Solution: Verify that the AccessKey is passed correctly during client initialization. os.Getenv("XXX") retrieves the value of XXX from environment variables.

Other common SDK errors and solutions: FAQ.