Alibaba Cloud C# Software Development Kit

中文文档

The Alibaba Cloud C# Software Development Kit (SDK) allows you to access Alibaba Cloud services such as Elastic Compute Service (ECS), Server Load Balancer (SLB), and CloudMonitor. You can access Alibaba Cloud services without the need to handle API related tasks, such as signing and constructing your requests.

This document introduces how to install and use Alibaba Cloud C# SDK.

If you have any problem while using C# SDK, please submit an issue.

Prerequisites

To use Alibaba Cloud C# SDK, you must have an Alibaba Cloud account and an AccessKey.

The AccessKey is required when initializing the client. You can create an AccessKey in the Alibaba Cloud console. For more information, see Create an AccessKey.

Note: To increase the security of your account, we recommend that you use the AccessKey of the RAM user to access Alibaba Cloud services.
To use Alibaba Cloud C# SDK to access the APIs of a product, you must first activate the product on the Alibaba Cloud console if required.
The Alibaba Cloud C# SDK is requires：
- .NET Framework 4.6.1 or later
- .NET Standard 2.0 or later

Using C# SDK with NuGet Packages

You must install the SDK core Nuget Package for any SDK you use. For example, to call the ECS product, you must install both the ECS Nuget Package and the SDK core Nuget Package.

Use Package Manager

Install-Package aliyun-net-sdk-core
Install-Package aliyun-net-sdk-ecs

Use .NET CLI

dotnet add package aliyun-net-sdk-core
dotnet add package aliyun-net-sdk-ecs

Alibaba Cloud C# SDK Product Nuget Packages:

aliyun-net-sdk-alidns
- Alibaba Cloud DNS (Domain Name System) helps enterprises and developers translate human-readable domain names into machine readable IP addresses for intercommunication. It then routes user requests to the corresponding websites or application servers.
aliyun-net-sdk-alimt
- Alibaba Machine Translation is an online intelligent machine translation service created by Alibaba. Relying on leading natural language processing technology and massive Internet data advantages, Alibaba successfully launched a deep neural network translation system (NMT) based on attention mechanism to help users to cross the language gap, enjoy communication and access information, and achieve barrier-free communication.
aliyun-net-sdk-arms
- Application Real-Time Monitoring Service (ARMS) is an end-to-end Alibaba Cloud monitoring service for Application Performance Management (APM). You can quickly develop real-time business monitoring capabilities using the frontend monitoring, application monitoring, and custom monitoring features provided by ARMS.
aliyun-net-sdk-arms4finance
aliyun-net-sdk-baas
- Alibaba Cloud BaaS (Blockchain as a Service ) is an enterprise-level PaaS (Platform as a Service) based on leading blockchain technologies. This service helps you build a stable, secure blockchain environment, and manage the deployment, operation, maintenance, and development of blockchains easily. Alibaba Cloud BaaS enables you to focus on business innovation.
aliyun-net-sdk-bssopenapi
- Alibaba Cloud BOA (BSS OpenAPI) is a comprehensive tool for managing Alibaba Cloud API operations related to Billing. You can use BOA to conveniently manage your Billing Accounts, orders, resource packages and bills during your using Alibaba Cloud services.
aliyun-net-sdk-cbn
aliyun-net-sdk-ccc
- The Cloud Call Center is equipped with Interactive Voice Response (IVR), Automatic Call Distribution (ACD) and a number of productivity-enhancing applications such as 100% coverage smart QA, easy-to-use and powerful business intelligence, and flexible CRM integration method.
aliyun-net-sdk-ccs
- The Cloud Customer Service relies on cutting-edge technologies such as data mining, search, voice-to-text, natural voice processing, and machine learning to create a complete intelligent service system.
aliyun-net-sdk-cdn
- You can use content delivery network (CDN) to deliver content to users from the nodes that are nearest to them, accelerating the response to user requests and increasing the response rate. CDN also resolves the delivery latency problem that is usually caused by distribution, bandwidth, and server performance issues. CDN has been applied in multiple scenarios, including site acceleration, on-demand streaming, and live streaming.
aliyun-net-sdk-chatbot
- A chatbot is a communication interface that assists organizations and individuals to converse decisively. It is an Artificial Intelligence program that chats with you. It offers a wide range of information that might be applicable. You can also term them as software applications that mimic written or spoken human speech to stimulate a conversation. Currently, there are two primary ways chatbots are offered to visitors: via standalone apps and web-based applications.
aliyun-net-sdk-cloudapi
aliyun-net-sdk-cloudauth
- The real person authentication service refers to the verification service of the natural person's true identity based on biometric identification technology such as living body detection, face comparison, and OCR identification technology.
aliyun-net-sdk-cloudesl
aliyun-net-sdk-cloudphoto
- The Cloud Photos is a one-stop solution for Alibaba Cloud for imaging applications. In addition to providing basic functions such as image file storage and management, intelligent cloud photo album also supports intelligent analysis of image content classification and face recognition, and provides intelligent search service based on natural language understanding.
aliyun-net-sdk-cloudwf
aliyun-net-sdk-cms
- CloudMonitor is a service that monitors Alibaba Cloud resources and Internet applications. The cloud monitoring service can be used to collect monitoring metrics for obtaining Alibaba Cloud resources, detect Internet service availability, and set alerts for metrics.
aliyun-net-sdk-core
aliyun-net-sdk-cs
- The Container Service provides a high-performance, scalable container application management service that enables application lifecycle management through a Docker container on a set of cloud servers.
aliyun-net-sdk-csb
aliyun-net-sdk-dcdn
- Dynamic Route For CDN (DCDN) is a high-performance, reliable, and secure full site acceleration solution. This service aims to accelerate access to hybrid sites that use both dynamic and static resources. DCDN integrates multiple products and services, such as dynamic acceleration systems, smart static content caching, HTTPS, and operations security. You can use DCDN to both speed-up access and ensure the stability of your site.
aliyun-net-sdk-dds
aliyun-net-sdk-dms-enterprise
- Data Management supports relational databases such as MySQL, SQL Server, PostgreSQL, PPAS, and Petadata, OLTP databases such as DRDS, OLAP databases such as ADS and DLA, and NoSQL database management such as MongoDB and Redis. It also supports Linux server management.
aliyun-net-sdk-domain
- Alibaba Cloud Domain Name Service is a comprehensive domain name management platform that integrates domain name registration, transaction, resolution, monitoring and protection.intl/)
aliyun-net-sdk-drds
- Distributed Relational Database Service (DRDS) focuses on solving the problem of single-machine relational database extensibility. It is lightweight (stateless), flexible, stable, and efficient.
aliyun-net-sdk-dysms
aliyun-net-sdk-dyvmsapi
aliyun-net-sdk-ecs
- Alibaba Cloud Elastic Compute Service (ECS) provides fast memory and the latest Intel CPUs to help you to power your cloud applications and achieve faster results with low latency. All ECS instances come with Anti-DDoS protection to safeguard your data and applications from DDoS and Trojan attacks.
aliyun-net-sdk-ehpc
- Elastic High Performance Computing (E-HPC) aggregates computing capabilities, and uses parallel computing to solve massive challenges of science, engineering, and business. E-HPC is applied to almost every aspect of our lives. E-HPC helps to solve problems in various fields including oil exploration, finance, emergency management, medicine, and IT.
aliyun-net-sdk-ess
- Auto Scaling is a management service that automatically adjusts elastic computing resources economically based on user's business needs and strategies.
aliyun-net-sdk-green
- Content security is a multimedia content intelligent identification service that supports diversified scene detection for images, videos, texts, voices, etc., effectively helping you reduce the risk of content violations.

In the Meanwhile, there are various product nuget package below.For more infomation, please visit the Alibaba Cloud Products & Services to get more detail.

Initiate a call

The following code example shows the three main steps to use the Alibaba Cloud C# SDK:

Create and initialize a DefaultAcsClient instance.
Create a request and set parameters.
Initiate the request and handle the response.

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

class TestProgram
{
    static void Main(string[] args)
    {
        // Create a client used for initiating a request
        IClientProfile profile = DefaultProfile.GetProfile(
            "<your-region-id>",
            "<your-access-key-id>",
            "<your-access-key-secret>");
        DefaultAcsClient client = new DefaultAcsClient(profile);

        try
        {
            // Create the request
            DescribeInstancesRequest request = new DescribeInstancesRequest();
            request.PageSize = 10;

            // Initiate the request and get the response
            DescribeInstancesResponse response = client.GetAcsResponse(request);
            System.Console.WriteLine(response.TotalCount);
        }
        catch (ServerException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
        catch (ClientException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
    }
}

Use BearerToken to invoke CCC Product

You should install the relative Nuget Package, as it said before, when you are running the test demo in your local machine.

using Aliyun.Acs.Core;
using Aliyun.Acs.Core.Profile;
using Aliyun.Acs.Core.Exceptions;
using Aliyun.Acs.CCC.Model.V20170705;

class TestProgram
{
    static void Main(string[] args)
    {
        // Create a client used for initiating a request
        IClientProfile profile = DefaultProfile.GetProfile("<your-region-id>");
        BearerTokenCredential bearerTokenCredential = new BearerTokenCredential("<your-bearertoken>");

        DefaultAcsClient client = new DefaultAcsClient(profile, bearerTokenCredential);

        try
        {
            // Create the request
            ListPhoneNumbersRequest request = new ListPhoneNumbersRequest();

            // Initiate the request and get the response
            var response = client.GetAcsResponse(request);
            
            //Do something as you want below
        }
        catch (ServerException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
        catch (ClientException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
    }
}

Debugging

If there exist an environment variable DEBUG=sdk , all http request/response will work in debug mode.

Timeout

Connect Time refers to the TCP connection establishment time from the SDK side to the server side;
Read Time refers to the time after the connection is established, the SDK sends a request (request) to the completion of the response end (response end);

Priority: Request Settings -> Client Settings -> Default Settings, the priority is decremented.

The default Connect Timeout is 5 seconds and the default Read Timeout is 10 seconds.

IClientProfile profile = DefaultProfile.GetProfile(
            "<your-region-id>",
            "<your-access-key-id>",
            "<your-access-key-secret>");

// Client level timeout setting, valid for all current requests
DefaultAcsClient client = new DefaultAcsClient(profile);
client.SetConnectTimeoutInMilliSeconds(1024);
client.SetReadTimeoutInMilliSeconds(2048);

// Request level timeout setting Take ECS DescribeInstancesRequest as an example, only valid for current request request
DescribeInstancesRequest request = new DescribeInstancesRequest();
request.SetConnectTimeoutInMilliSeconds(1024);
request.SetReadTimeoutInMilliSeconds(2048);

Ignore HTTPS certificate verification

When you want to turn off the verification of the HTTPS certificate on the client, you can set it at the Client or Request level.

//  Client level certificate ignores verification
client.SetHttpsInsecure(true);

// Request level certificate ignores verification
request.SetHttpsInsecure(true);

Http Proxy

If you want to use the http, https proxy or proxy whitelist, you can set the environment variables HTTP_PROXY , HTTPS_PROXY and NO_PROXY , or you can configure them via the client.

//Client priority is higher than environment variable

//Set up the http proxy
client.SetHttpProxy("http://localhost.com");
//Get http proxy
client.GetHttpProxy();

//Set up the https proxy
client.SetHttpsProxy("https://localhost.com");
client.SetHttpsProxy("http://username:password@localhost.com:10");
//Get https proxy
client.GetHttpsProxy();

//Set proxy whitelist
client.SetNoProxy("localhost.com,localtest.com");
//Get the agent white list
client.GetNoProxy();

.NET OpenAPI Explorer

You can see the product code examples you are using in the OpenAPI Explorer.

six006/aliyun-openapi-net-sdk