Alibaba Cloud SDK:Integrate the SDK

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

2. On the Installation page, and for All Languages, select Go. On the Quick Start tab, you can get the SDK installation method for Short Message Service (SMS).

   Command to install the SDK core library: go get github.com/alibabacloud-go/darabonba-openapi/v2/client. Command to install the Short Message Service (SMS) SDK: go get github.com/alibabacloud-go/dysmsapi-20170525/v4. Release and source code repository: https://github.com/alibabacloud-go/dysmsapi-20170525/.

Special scenario: Configure the Advance API for file uploads

When you use cloud products such as Image Search and Visual Intelligence API to process local images or upload images, the OpenAPI operations provided in the official documentation do not support uploading files directly. To upload a file, you can use the Advance API provided by the cloud product, which supports passing a file stream object. The underlying mechanism is: the cloud product temporarily stores the uploaded file in Alibaba Cloud OSS, with the default storage region being cn-shanghai, and implements the related feature by reading the temporary file from that OSS. This example uses the DetectBodyCount API of Visual Intelligence API, and the procedure is as follows.

1. Initialize the request client

   Note that you need to set both RegionId and the Endpoint of the cloud product. RegionId specifies the region where the temporary file is stored in OSS. If RegionId is not set, timeouts may occur when you call the OpenAPI operation, because the cloud product and OSS may be 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 AdvanceRequest struct instance

   When you upload a local file, you need to use the AdvanceRequest struct provided by the SDK to pass the file stream. The naming format of the AdvanceRequest struct is <OpenAPI name>AdvanceRequest. For the name of the parameter that passes the file stream, find the parameter whose type is io.Reader in the corresponding AdvanceRequest struct.

   // 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 the request

   Call the <API name>Advance function to send the request. The input parameter is 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 operation.

   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. For information about how to grant permissions to a RAM user, see Manage RAM user permissions.

   For example, if the error "You are not authorized to perform this operation" occurs when you call the SendMessageToGlobe API, you can create a custom access policy and grant it to the RAM user.

   {
     "Version": "1",
     "Statement": [
       {
         "Effect": "Allow",
         "Action": "dysms:SendMessageToGlobe",
         "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 operation.

   Cause and solution

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

   Solution: See Configure endpoints. Modify the Endpoint and call the OpenAPI operation again.

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 operation.

   Cause and solution

   Cause: Your AccessKey was not passed correctly.

   Solution: Check whether the AccessKey is passed correctly when you initialize the request client. Note that os.Getenv("XXX") retrieves the value of XXX from environment variables.

For solutions to more errors that occur when you use the SDK, see FAQ.