Skip to content

Latest commit

 

History

History
175 lines (127 loc) · 7.29 KB

README-CN.md

File metadata and controls

175 lines (127 loc) · 7.29 KB
Raw

English | 简体中文

Alibaba Cloud SDK for .NET

Travis Build Status Appveyor Build Status Codecov Nuget Version Nuget Version Nuget Version

欢迎使用 Alibaba Cloud SDK for .NET ，让您不用复杂编程即可访问云服务器、云监控等多个阿里云服务。

使用Demo及其示例

您可以在 OpenAPI Explorer 中查看您所使用的产品代码示例。

环境要求

Alibaba Cloud SDK for .NET 适用于:

  • .NET Framework 4.5 及其以上版本
  • .NET Standard 2.0 及其以上版本。
  • C# 4.0 及其以上版本

安装

进入 Alibaba Cloud SDK for .NET Nuget Package 页面，查看已发布的阿里云产品 SDK 模块列表。

注意： 部分阿里云产品的 SDK 未收录到这个列表中，例如对象存储（OSS），表格存储（Table Store），请前往这些产品的详情页获取相应的 SDK。

使用ECS产品时，应安装 ECS Nuget Package。 如果要安装特定版本，请添加--version，否则它将安装此软件包的最新版本。

您可以通过 NuGet 程序包管理器来安装：

  • 在 解决方案资源管理器面板 中右击您的项目选择 管理 NuGet 程序包 菜单，在打开的 NuGet 管理面板 中点击 浏览 选项卡输入 aliyun-net-sdk，在下方列表中选择 Authors 为 Alibaba Cloud 由官方发布的各产品模块，选择您期望的模块点击 安装 即可。

或者通过 .NET CLI 工具来安装（以安装 ECS为例）

dotnet add package aliyun-net-sdk-ecs

快速开始

  • 要使用 Alibaba Cloud SDK for .NET，您需要一个云账号以及一对 Access Key ID 和 Access Key Secret。请在阿里云控制台中的 AccessKey 管理页面 上创建和查看您的 Access Key，或者联系您的系统管理员。

  • 要使用 Alibaba Cloud SDK for .NET 访问某个产品的 API，您需要事先在 阿里云控制台 中开通这个产品。

以下这个代码示例向您展示了调用阿里云 .NET SDK 的 3 个主要步骤：

  1. 创建 DefaultAcsClient 实例并初始化；
  2. 创建 API 请求并设置参数；
  3. 发起请求并处理返回。
using Aliyun.Acs.Core;
using Aliyun.Acs.Core.Profile;
using Aliyun.Acs.Core.Exceptions;
using Aliyun.Acs.Ecs.Model.V20140526;

class Program
{
    static void Main(string[] args)
    {
        // 构建一个 Client，用于发起请求
        IClientProfile profile = DefaultProfile.GetProfile(
            "<your-region-id>",
            "<your-access-key-id>",
            "<your-access-key-secret>");
        DefaultAcsClient client = new DefaultAcsClient(profile);

        try
        {
            // 构造请求
            DescribeInstancesRequest request = new DescribeInstancesRequest();
            request.PageSize = 10;

            // 发起请求，并得到 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());
        }
    }
}

在创建 DefaultAcsClient 实例并初始化时，您需要填写 3 个参数：Region ID、Access Key ID 和 Access Key Secret。Access Key ID 和 Access Key Secret 可以从控制台获得；而 Region ID 可以从 地域列表 中获得。

使用 BearerToken 调用 CCC 产品

首先需要保证您已经安装了相应的 Nuget 包依赖。

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

class Program
{
    static void Main(string[] args)
    {
        // 构建一个 Client，用于发起请求
        var profile = DefaultProfile.GetProfile("<your-region-id>");
        var bearerTokenCredentialProvider = new BearerTokenCredentialProvider("<your-bearertoken>");

        var client = new DefaultAcsClient(profile, bearerTokenCredentialProvider);

        try
        {
            // 构造请求
            var request = new ListPhoneNumbersRequest();

            // 发起请求，并得到 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());
        }
    }
}

文档

问题

提交Issue，不符合指南的问题可能会立即关闭。

发行说明

每个版本的详细更改记录在 发行说明 中。

API参考

要知道您想访问的产品提供的 API 以及它们的参数，请参考开放 API 的 产品列表。

许可证

源码基于 Apache License 2.0 许可协议开放授权

FOSSA Status