简介
欢迎使用阿里云开发者工具套件(SDK)。阿里云 .NET SDK 让您不用复杂编程即可访问云服务器、云监控等多个阿里云服务。这里向您介绍如何获取阿里云 .NET SDK 并开始调用。
环境准备
阿里云 .NET SDK 适用于 .NET Framework 4.0 及以上版本。
要使用阿里云 .NET SDK,您需要一个云账号以及一对Access Key ID和Access Key Secret。请在阿里云控制台中的 AccessKey 管理页面上创建和查看您的 Access Key,或者联系您的系统管理员。
要使用阿里云 SDK 访问某个产品的 API,您需要事先在阿里云控制台中开通这个产品。
SDK 获取和安装
进入
阿里云 .NET SDK。
请注意,部分阿里云产品的 SDK 未收录到这个列表中,例如对象存储(OSS),表格存储(Table Store),请前往这些产品的详情页获取相应的 SDK。
要成功地调用一个产品的 SDK,
您至少需要首先安装SDK 核心库。例如,对云服务器 SDK 的调用,您需要获取和安装 2 个 SDK,分别是SDK 核心库和云服务器的 SDK。
您可以通过以下几种方式来安装阿里云 .NET SDK:
方式一:添加 DLL 引用
从
.NET SDK 发布列表 这个地址中下载包含 DLL 文件的压缩包,解压获得 DLL 文件。
在Visual Studio的解决方案资源管理器中选择您的项目,然后右键项目名称 -> 引用,在弹出的菜单中选择添加引用,在弹出添加引用对话框后,选择浏览,选择之前下载并解压好的 DLL 文件,单击
确定即可。
方式二:项目引入方式
首先从 GitHub 上下载 .NET SDK 的源代码:
- git clone https://github.com/aliyun/aliyun-openapi-net-sdk.git
您可以在下载生成的文件夹中,找到很多名为 aliyun-net-openapi-XXX 的子文件夹,里面都有一个*.csproj文件,即
C# 项目文件。例如,在 aliyun-net-openapi-ecs 子文件夹下,有一个 aliyun-net-sdk-ecs.csproj 文件。
在Visual Studio的界面中,右键解决方案,在弹出的菜单中单击添加->现有项目。在弹出的对话框中,选择刚才下载的源代码中相应的 C# 项目文件(例如aliyun-net-sdk-ecs.csproj),单击
打开。
接下来,右键您的项目 -> 引用,选择添加引用,在弹出的对话框选择项目选项卡后选中刚才打开的项目(例如aliyun-net-sdk-ecs),单击
确定即可。
开始调用
以下这个代码示例向您展示了调用阿里云 SDK 的 3 个主要步骤:
- 创建 DefaultAcsClient 实例并初始化;
- 创建 API 请求并设置参数;
- 发起请求并处理返回。
- using System;
- using System.Collections.Generic;
- using System.Linq;
- using System.Text;
- using System.Threading.Tasks;
- using Aliyun.Acs.Core;
- using Aliyun.Acs.Core.Profile;
- using Aliyun.Acs.Core.Exceptions;
- using Aliyun.Acs.Ecs.Model.V20140526;
- namespace TestApp
- {
- class TestProgram
- {
- static void Main(string[] args)
- {
- // 构建一个 Aliyun Client,用于发起请求
- IClientProfile profile = DefaultProfile.GetProfile(
- "<your-region-id>",
- "<your-access-key-id>",
- "<your-access-key-secret>");
- DefaultAcsClient client = new DefaultAcsClient(profile);
- // 构造请求
- DescribeInstancesRequest request = new DescribeInstancesRequest();
- request.PageSize = 10;
- // 发起请求,并得到 Response
- try
- {
- 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());
- }
- }
- }
- }
在创建 DefaultAcsClient 实例并初始化时,您需要填写 3 个参数:Region ID、Access Key ID和Access Key Secret。Access Key ID和Access Key Secret可以从控制台获得;而Region ID可以从
地域列表中获得。
API参考
要知道您想访问的产品提供的 API 以及它们的参数,请参考
开放了 API 的产品列表。