Alibaba Cloud SDK:Integrate Alibaba Cloud SDK V2.0 for .NET

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 Short Message Service page, select C# in the All languages section. On the Quick Start tab, obtain the installation method of Short Message Service (SMS) SDK.

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.

   public static AlibabaCloud.SDK.Facebody20191230.Client CreateClient()
   {
       AlibabaCloud.OpenApiClient.Models.Config config =
           new AlibabaCloud.OpenApiClient.Models.Config
           {
               // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_ID. 
               AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
               // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_SECRET. 
               AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
           };
       config.RegionId = "cn-shanghai";
       config.Endpoint = "facebody.cn-shanghai.aliyuncs.com";
       return new AlibabaCloud.SDK.Facebody20191230.Client(config);
   }

2. Create a request object

   Create the <API operation>AdvanceRequest request object to pass file streams. In the request object, set the parameter name to ImageURLObject.

   AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountAdvanceRequest detectBodyCountAdvanceRequest =
       new AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountAdvanceRequest
       {
           ImageURLObject = File.OpenRead(@"<FILE_PATH>"), // Replace <FILE_PATH> with the actual file path.
       };   

3. Initiate a request

   Call the <API operation name>Advance function to initiate a request.

   // Configure the runtime parameters.
   AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
   AlibabaCloud.SDK.Facebody20191230.Client client = CreateClient();
   // Send the request.
   AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountResponse response = client.DetectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);
   Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(response));

// dotnet add package AlibabaCloud.SDK.Facebody20191230 --version 4.1.2

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample
    {
        public static AlibabaCloud.SDK.Facebody20191230.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config =
                new AlibabaCloud.OpenApiClient.Models.Config
                {
                    // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_ID. 
                    AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
                    // Required. Make sure that the following environment variable is set in the code runtime environment: ALIBABA_CLOUD_ACCESS_KEY_SECRET. 
                    AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
                };
            config.RegionId = "cn-shanghai";
            config.Endpoint = "facebody.cn-shanghai.aliyuncs.com";
            return new AlibabaCloud.SDK.Facebody20191230.Client(config);
        }

        public static void Main(string[] args)
        {
            try
            {
                AlibabaCloud.SDK.Facebody20191230.Client client = CreateClient();
                // Replace <FILE_PATH> with the actual file path.
                using (FileStream fileStream = File.OpenRead(@"<FILE_PATH>"))
                {
                    AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountAdvanceRequest detectBodyCountAdvanceRequest =
                        new AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountAdvanceRequest
                        {
                            ImageURLObject = fileStream,
                        };
                    AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
                    AlibabaCloud.SDK.Facebody20191230.Models.DetectBodyCountResponse response =
                        client.DetectBodyCountAdvance(detectBodyCountAdvanceRequest, runtime);
                    Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(response));
                }
            }
            catch (TeaException error)
            {
                // Handle exceptions with caution based on your actual business scenario and do not ignore exceptions in your project. The error messages displayed in this example are for reference only. 
                Console.WriteLine(error.Message);
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
            catch (Exception _error)
            {
                TeaException error = new TeaException(
                    new Dictionary<string, object> { { "message", _error.Message } }
                );
                // Handle exceptions with caution based on your actual business scenario and do not ignore exceptions in your project. The error messages displayed in this example are for reference only. 
                Console.WriteLine(error.Message);
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
        }
    }
}

FAQ

• How do I handle the "You are not authorized to perform this operation" error thrown by an API operation?

  Cause: The AccessKey pair used by the Resource Access Management (RAM) user does not have the permissions to call the API operation.

  Solution: 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": "*"
      }
    ]
  }

• How do I handle the "System.UnretryableException: One or more errors occurred" error thrown by an API operation?

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

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

• How do I handle the "ErrorCode":"InvalidAccessKeyId.NotFound","ErrorMessage":"Specified access key is not found" error thrown by an API operation?

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

  Solution: Make sure that the AccessKey pair is correctly passed when you initialize the request client. Environment.GetEnvironmentVariable("XXX") indicates that the XXX value is obtained from the environment variable.

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