使用CommonRequest进行调用 - 阿里云SDK

说明

当您要调用的某个产品的API没有提供SDK时，可以采用泛用型的API调用方式（CommonRequest）。使用CommonRequest调用方式可实现任意OpenAPI接口的调用。

CommonRequest调用特点

CommonRequest的特点如下：

轻量：只需Core包即可发起调用，无需下载安装各产品的SDK。
简便：无需更新SDK即可调用最新发布的API。
快速迭代。

使用CommonRequest

阿里云产品的API有RPC和RESTful两种风格，不同风格的API的CommonRequest的调用方法也不同。

通常API参数中包含Action参数的是RPC风格，包含PathPattern参数的是RESTful风格。一般情况下，每个产品内，所有API的调用风格是统一的。每个API仅支持特定的一种风格调用，传入错误的标识，可能会调用到其他API，或收到ApiNotFound的错误信息。

发起一次CommonRequest请求，您需要获取以下几个参数的值。您可以在文档中心各产品的API文档中获取以下参数的值。此外，部分产品也可以通过OpenAPI 开发者门户来获取API的参数信息。

域名（domain）：该产品的服务地址。
API版本（version）：该API的版本号，格式为YYYY-MM-DD。
接口信息：要调用的接口名称。
- 当调用的API为RPC风格（大部分阿里云产品API为RPC风格，如ECS和RDS）时，需要获取Action参数，使用request.ApiName = "<Action>"的方式来指定API名称。
  - 例如RunInstances接口，在发起CommonRequest请求时，需要使用request.ApiName = "RunInstances"来指定API名称。
- 当调用的API为RESTful风格（如容器服务）时，需要获取PathPattern参数，使用request.PathPattern = "<PathPattern>"的方式来指定RESTful路径。
  - 例如容器服务的查看所有集群实例的API的PathPattern为/clusters，在发起CommonRequest请求时，要使用request.PathPattern = "/clusters"指定RESTful路径。

示例：调用RPC风格的API

以下代码展示了如何使用CommonRequest的方式调用ECS的DescribeInstanceStatus接口：

using Aliyun.Acs.Core;
using Aliyun.Acs.Core.Exceptions;
using Aliyun.Acs.Core.Profile;
class Sample
{
    static void Main(string[] args)
    {
        // 构建一个客户端实例，用于发起请求
        IClientProfile profile = DefaultProfile.GetProfile(
            // 地域ID
            "<your-region-id>",
            // 从环境变量获取RAM账号的AccessKey ID
            Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // 从环境变量获取RAM账号的AccessKey ID
            Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        DefaultAcsClient client = new DefaultAcsClient(profile);
        try
        {
            // 构造请求
            CommonRequest request = new CommonRequest();
            request.Domain = "ecs.aliyuncs.com";
            request.Version = "2014-05-26";
            // 因为是 RPC 风格接口，需指定 ApiName(Action)
            request.Action = "DescribeInstanceStatus";
            request.AddQueryParameters("PageNumber", "1");
            request.AddQueryParameters("PageSize", "30");
            // 发起请求，并得到 Response
            CommonResponse response = client.GetCommonResponse(request);
            System.Console.WriteLine(response.Data);
        }
        catch (ServerException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
        catch (ClientException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
    }
}

示例：调用RESTful（ROA）风格的API

以下代码展示了如何使用CommonRequest的方式调用容器服务的查看所有集群实例接口：

using Aliyun.Acs.Core;
using Aliyun.Acs.Core.Exceptions;
using Aliyun.Acs.Core.Profile;
class Sample
{
    static void Main(string[] args)
    {
        // 构建一个 Client，用于发起请求
        IClientProfile profile = DefaultProfile.GetProfile(
            // 地域ID
            "<your-region-id>",
            // 从环境变量获取RAM账号的AccessKey ID
            Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
            // 从环境变量获取RAM账号的AccessKey ID
            Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
        DefaultAcsClient client = new DefaultAcsClient(profile);
        try
        {
            // 构造请求
            CommonRequest request = new CommonRequest();
            request.Domain = "cs.aliyuncs.com";
            request.Version = "2015-12-15";
            // 因为是Restful风格接口，需指定 UriPattern
            request.UriPattern = "/clusters";
            // 发起请求，并得到 Response
            CommonResponse response = client.GetCommonResponse(request);
            System.Console.WriteLine(response.Data);
        }
        catch (ServerException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
        catch (ClientException ex)
        {
            System.Console.WriteLine(ex.ToString());
        }
    }
}