Java SDK示例

本文介绍了运维事件中心Java SDK的安装方法以及代码示例。

Java SDK安装方法

Java SDK包含阿里云Java SDK基础包(aliyun-java-sdk-core)和运维事件中心接口定义包(gemp20210413),两者都要安装。

  • 方法一

    通过Maven管理项目依赖,在项目中的pom文件中加入以下依赖项:

    <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>gemp20210413</artifactId>
       <version>1.0.4</version>
      </dependency>
      <dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>aliyun-java-sdk-core</artifactId>
       <version>4.5.22</version>
      </dependency>
  • 方法二

    手动下载并导入SDK JAR文件,以下为最新版本JAR下载链接:

配置访问凭证

重要

阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。

配置环境变量ADBPG_AK_ENVADBPG_SK_ENV

  • Linux和macOS系统配置方法,执行以下命令:

    export ADBPG_AK_ENV=<access_key_id>
    export ADBPG_SK_ENV=<access_key_secret>

    <access_key_id>替换为已准备好的AccessKey ID,<access_key_secret>替换为AccessKey Secret。

  • Windows系统配置方法:

    1. 新建环境变量,添加环境变量ADBPG_AK_ENVADBPG_SK_ENV,并写入已准备好的AccessKey ID和AccessKey Secret。

    2. 重启Windows系统。

Java SDK示例

关于SDK代码示例中参数的解释,请参考运维事件中心API文档

代码示例

import com.aliyun.gemp20210413.models.ListUsersRequest;
import com.aliyun.gemp20210413.models.ListUsersResponse;
import com.aliyun.teaopenapi.models.Config;
import com.google.gson.Gson;

public class ListUsers {

    public static void main(String[] args) {
        
        //构建一个阿里云客户端, 用于发起请求。
        Config authConfig = new Config();
        authConfig.endpoint = "<your-endpoint>";
        authConfig.regionId = "<your-region-id>";
      
        // 阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。
        // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
        // 本示例通过从环境变量中读取AccessKey,来实现API访问的身份验证。运行代码示例前,请先配置环境变量。
      
        authConfig.accessKeyId = System.getenv("ADBPG_AK_ENV");
        authConfig.accessKeySecret = System.getenv("ADBPG_SK_ENV");
      	Client authClient = new Client(authConfig);
        //构建请求,设置参数。关于参数含义和设置方法,请参见API参考。
        ListUsersRequest request = new ListUsersRequest();
        request.clientToken = "<your-client-token>";
        request.pageNumber = 1L;
        request.pageSize = 1L;
        
        //发起请求,并得到响应。
        ListUsersResponse response = authClient.listUsers(request);
        System.out.println(new Gson().toJson(response));
        System.out.println(new Gson().toJson(response.body.data));

    }
}

结果示例

{
    "headers":
    {
        "access-control-allow-origin": "*",
        "date": "Mon, 19 Jul 2021 07:53:33 GMT",
        "access-control-max-age": "172800",
        "transfer-encoding": "chunked",
        "vary": "Accept-Encoding",
        "x-acs-request-id": "25A5EDF9-CD77-4824-B6A8-957E87701C7F",
        "access-control-allow-headers": "X-Requested-With, X-Sequence, _aop_secret, _aop_signature",
        "connection": "keep-alive",
        "content-type": "application/json;charset=utf-8",
        "access-control-allow-methods": "POST, GET, OPTIONS"
    },
    "body":
    {
        "requestId": "25A5EDF9-CD77-4824-B6A8-957E87701C7F",
        "data":
        [
            {
                "userId": 85,
                "ramId": 121********1,
                "username": "张老三",
                "phone": "188******97",
                "email": "1122*****3@qq.com",
                "isEditableUser": 1,
                "accountType": 1
            }
        ],
        "totalCount": 25,
        "pageNumber": 1,
        "pageSize": 1
    }
}