首页 云AP 开发指南 接入指南

接入指南

本文档介绍云AP OpenAPI 的接入步骤以及注意事项,包含 SDK 的获取,以及初始化参数的设置。

1.SDK 获取

直接填写以下 POM 的配置,依赖 OpenAPI 的 SDK 即可。

<dependencies>
          <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-core</artifactId>
            <version>3.2.10</version>
          </dependency>
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-cloudwf</artifactId>
            <version>1.0.2</version>
        </dependency>
</dependencies>

2. 公共参数设置

OpenAPI 使用时需要启动 OpenAPI 的客户端,而客户端启动时需要设置接入点和 AccessKey,SecretKey 等参数信息,具体示例如下:

    /**
    *OpenAPI 的接入点,设置为目标 Region
    */
    String regionId = "XXXXX";
    /**
    *鉴权使用的 AccessKey,由阿里云官网控制台获取
    */
    String accessKey = "XXXXXXXXXXXXXXXXX";
    /**
    *鉴权使用的 SecretKey,由阿里云官网控制台获取
    */
    String secretKey = "XXXXXXXXXXXXXXXXX";
    /*
    *通过 OpenAPI 访问的云产品名称,此处设置为 cloudwf 即可
    */
    String productName ="cloudwf";
    /**
    *对应 endPoint 接入点的接入点域名
    */
    String domain ="cloudwf.aliyuncs.com";
    try {
        DefaultProfile.addEndpoint(regionId,regionId,productName,domain);
        IClientProfile profile= DefaultProfile.getProfile(regionId,accessKey,secretKey);
        IAcsClient iAcsClient= new DefaultAcsClient(profile);
        AddApgroupConfigRequest req = new AddApgroupConfigRequest();
        req.setName("TestApGroup");
        req.setDescription("TestApGroup");
        req.setParentApgroupId(88L);
        AddApgroupConfigResponse resp = (AddApgroupConfigResponse)client.getAcsResponse(req);
    } catch (ClientException e) {
        e.printStackTrace();
    }
参数说明
  • regionId:指的是 API 的网关所在区域,目前在cn-hangzhou。

  • accessKey:指的是用户在阿里云服务器管理控制台上获取的 AK。

  • secretKey:指的是用户在阿里云服务器管理控制台上获得的 SK。

  • endPointName:接入点名称,同 RegionId 一致即可。

  • productName:OpenAPI 的产品名称,直接写 cloudwf 即可。

  • domain:OpenAPI 的接入点 Domain,直接写cloudwf.aliyuncs.com。

阿里云首页 云AP 相关技术圈