SDK integration

V1.0 SDK dependency information for cloud products

The V1.0 SDK for .NET of an Alibaba Cloud service provides request and response objects for API operations and an unmarshaller object for serializing return values. The following example shows how to add the Elastic Compute Service (ECS) SDK as a dependency:

dotnet add package aliyun-net-sdk-ecs

# Specify the version using --version.
dotnet add package aliyun-net-sdk-ecs --version 4.24.18

Install-Package aliyun-net-sdk-ecs

# Specify the version using -version.
Install-Package aliyun-net-sdk-ecs -Version 4.24.18

<PackageReference Include="aliyun-net-sdk-ecs" Version="4.24.18" />

paket add aliyun-net-sdk-ecs --version 4.24.18

#r "nuget: aliyun-net-sdk-ecs, 4.24.18"

Core SDK dependencies

The Core SDK handles HTTP requests to OpenAPI, authentication, signature algorithms, and exception handling. Add the dependency as follows:

dotnet add package aliyun-net-sdk-core

Use the SDK

1. Initialize a client

In SDK V1.0 for .NET, all Alibaba Cloud service SDKs share the same core library. You can use the core library to initialize an SDK client that processes API requests. The following example shows how to initialize a client. For more information about initialization methods, see Manage access credentials.

static void Main(string[] args)
{
    IClientProfile profile = DefaultProfile.GetProfile(
        // The region ID.
        "<REGION_ID>",
        // Obtain the AccessKey ID of the RAM user from an environment variable.
        Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
        // Obtain the AccessKey secret of the RAM user from an environment variable.
        Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
    DefaultAcsClient client = new DefaultAcsClient(profile);
}

2. Construct a request object and initiate a request

SDK V1.0 for .NET sends API requests through the core library. You pass request parameters using the request object from the service SDK, then call the initialized client to send the request and receive a response object. The following example uses the ECS SDK to query ECS instance information.

using Aliyun.Acs.Core;
using Aliyun.Acs.Core.Profile;
using Aliyun.Acs.Ecs.Model.V20140526;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {
        static void Main(string[] args)
        {
            IClientProfile profile = DefaultProfile.GetProfile(
                // The region ID.
                "<REGION_ID>",
                // Obtain the AccessKey ID of the RAM user from an environment variable.
                Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
                // Obtain the AccessKey secret of the RAM user from an environment variable.
                Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
            DefaultAcsClient client = new DefaultAcsClient(profile);
            // Create a request object.
            DescribeInstancesRequest request = new DescribeInstancesRequest{
                RegionId = "<REGION_ID>"
            };;
            // Send the request from the client and serialize the result into a Response object.
            DescribeInstancesResponse response = client.GetAcsResponse(request);
            System.Console.WriteLine(response.TotalCount);
        }
    }
}