Alibaba Cloud SDK:Integrate an SDK

1. Log on to SDK Center and select the service whose SDK you want to use. In this example, Short Message Service (SMS) is selected.

2. On the Install page, 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: File upload through the Advance operation

When you use Image Search or Visual Intelligence API (VIAPI) to process images on an on-premises machine or upload images, the API of the Image Search or VIAPI described in the documentation does not support direct upload. To upload images, you need to use the Advance operation, which supports transmission of file streams. The cloud service temporarily stores the uploaded file in Object Storage Service (OSS), and reads the temporary file from OSS when necessary. The default region of OSS is cn-shanghai. The following example shows how to call the DetectBodyCount operation of VIAPI:

1. Initialize a request client

   Make sure that both the RegionId parameter and the endpoint of the cloud service are specified. RegionId indicates the OSS region in which the temporary files are stored. If you do not configure the RegionId parameter, the cloud service may use a different region than OSS, resulting in API timeouts.

   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 in your runtime environment.
       AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
       // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set in your runtime environment.
       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 must use the AdvanceRequest struct provided by the SDK to pass the file stream. The naming format for the AdvanceRequest struct is <OpenAPI operation name>AdvanceRequest. To find the parameter name for passing the file stream, look for the parameter of the io.Reader type 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 instance of the AdvanceRequest struct.
   detectBodyCountAdvanceRequest := &facebody20191230.DetectBodyCountAdvanceRequest{
     ImageURLObject: file,
   }

3. Initiate a request

   Call the <Operation name>Advance function to initiate 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 statement.
   
   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{}
     // Initiate 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 in your runtime environment.
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // Required. Make sure that the ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variable is set in your runtime environment.
    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{}
  // Initiate 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. How do I handle the "You are not authorized to perform this operation" error thrown by an API operation?

   Possible causes and solutions

   Possible causes: The AccessKey pair of the Resource Access Management (RAM) user does not have the permissions to call the API operation.

   Solutions: Grant the required permissions to the RAM user. For more information, see Grant permissions to a RAM user.

   For example, if the "You are not authorized to perform this operation" error is thrown by the SendMessageToGlobe API operation, create the following custom policy to grant the required permissions to the RAM user:

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

2. How do I handle the "SDKError: Message: Post "https://ecs-cn-XX.aliyuncs.com": dial tcp: lookup ecs-cn-XX.aliyuncs.com: no such host" error thrown by an API operation?

   Possible causes and solutions

   Possible causes: The API operation does not support the endpoint that you specify when you initialize the request client.

   Solutions: Specify a supported endpoint and try again. For more information, see Configure an endpoint.

3. How do I handle the "SDKError: StatusCode: 404 Code: InvalidAccessKeyId.NotFound Message: code: 404, Specified access key is not found" error thrown by an API operation?

   Possible causes and solutions

   Possible causes: The AccessKey pair is not correctly passed to the request.

   Solutions: Make sure that the AccessKey pair is correctly passed when you initialize the request client. The XXX value of os.Getenv("XXX") is obtained form the environment variable.

For more information about how to handle SDK errors, see FAQ.