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

CommonRequest调用特点

CommonRequest有如下特点:

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

使用CommonRequest

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

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

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

  • 域名(domain):该产品的通用访问域名。

  • API版本(version):该API的版本号,格式为YYYY-MM-DD。

    您可以在各产品的API文档的公共参数部分获取API版本。

  • 接口信息:要调用的接口名称。
    • 当调用的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接口:
#include <iostream>
#include <alibabacloud/core/AlibabaCloud.h>
#include <alibabacloud/core/CommonClient>.

using namespace AlibabaCloud;

int main(int argc, char** argv)
{
    // 初始化 SDK
    AlibabaCloud::InitializeSdk();

    // 配置 ecs 实例
    ClientConfiguration configuration("<your-region-id>");
    CommonClient client("<your-access-key-id>", "<your-access-key-secret>", configuration);

    // 创建API请求并设置参数
    CommonRequest request(CommonRequest::RpcPattern);
    request.setDomain("ecs.aliyuncs.com");
    request.setVersion("2014-05-26");
    // 因为是 RPC 风格接口,需指定 ApiName(Action)
    request.setQueryParameter("Action", "DescribeInstanceStatus");
    request.setQueryParameter("PageNumber", "1");
    request.setQueryParameter("PageSize", "30");
    auto outcome = client.commonResponse(request);
    if (!outcome.isSuccess())
    {
        // 异常处理
        std::cout << outcome.error().errorCode() << std::endl;
        AlibabaCloud::ShutdownSdk();
        return -1;
    }
    std::cout << "result: " << outcome.result().payload() << std::endl;

    // 关闭 SDK
    AlibabaCloud::ShutdownSdk();
    return 0;
}

示例:调用RESTful风格的API

以下代码展示了如何使用CommonRequest的方式调用容器服务的查看所有集群实例接口:
#include <iostream>
#include <alibabacloud/core/AlibabaCloud.h>
#include <alibabacloud/core/CommonClient.h>

using namespace AlibabaCloud;

int main(int argc, char** argv)
{
    // 初始化 SDK
    AlibabaCloud::InitializeSdk();

    // 配置 ecs 实例
    ClientConfiguration configuration("<your-region-id>");
    CommonClient client("<your-access-key-id>", "<your-access-key-secret>", configuration);

    // 创建API请求并设置参数
    CommonRequest request(CommonRequest::RoaPattern);
    request.setDomain("cs.aliyuncs.com");
    request.setVersion("2015-12-15");
    // 因为是 Restful 风格接口,需指定 ResourcePath
    request.setResourcePath("/clusters");
    auto outcome = client.commonResponse(request);
    if (!outcome.isSuccess())
    {
        // 异常处理
        std::cout << outcome.error().errorCode() << std::endl;
        AlibabaCloud::ShutdownSdk();
        return -1;
    }

    std::cout << "result: " << outcome.result().payload() << std::endl;

    // 关闭 SDK
    AlibabaCloud::ShutdownSdk();
    return 0;
}