文档

Java SDK

更新时间:

本文介绍安装云网管Java SDK及使用Java SDK完成常见操作的相关步骤。

前提条件

  • 已开通云网管。更多信息,请参见开通使用云网管

  • 已创建并获取AccessKey。更多信息,请参见访问密钥

  • 已安装Java开发环境。

    • 云网管Java SDK支持J2SE 6.0及以上的Java运行环境,您可以执行java -version命令检查您已安装的Java版本。如果未安装,可以从Java官方网站下载安装包并完成安装。

步骤1:安装Java SDK

您可以通过以下两种方式安装云网管Java SDK:

  • 方式一:在Maven项目中加入依赖项(推荐方式)。

    • 在Maven工程中使用云网管Java SDK,只需在pom.xml中加入相应依赖即可。以0.0.1版本为例,在<dependencies>中加入如下内容:

            <dependency>
                <groupId>com.aliyun</groupId>
                <artifactId>cmn20200825</artifactId>
                <version>0.0.1</version>
            </dependency>
  • 方式二:在Eclipse中导入JAR包。

    • 以0.0.1版本为例,步骤如下:

      1. 下载Java SDK,下载链接请参见Aliyun CMN Java SDK

      2. 将cmn20200825-0.0.1.jar拷贝到您的项目中。

      3. 在Eclipse中选择您的工程,右击选择Properties > Java Build Path > Add JARs。

      4. 选中步骤2中拷贝的JAR文件。

步骤2:创建云网管Client

Client是云网管的Java客户端,用于管理Device,MonitorItem等云网管资源。使用Java SDK发起云网管请求,您需要初始化一个Client实例。

Config authConfig = new Config();
/**
 *  阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。
 *  强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
 *  调用接口前请先配置身份认证,具体操作请参见https://help.aliyun.com/document_detail/378657.html。
 *  本示例使用了阿里云Credentials工具托管AccessKey,来实现API访问的身份验证。
 */
com.aliyun.credentials.Client credentialClient = new com.aliyun.credentials.Client();
authConfig.endpoint = "region_endpoint"; //在实际使用中,请按照您实际的服务入口和接入方式编写。
authConfig.regionId = "cn-hangzhou"; //在实际使用中,请按照您实际的服务地域编写。
authConfig.setCredential(credentialClient);

Client authClient = new Client(authConfig);

Java SDK示例

此处以分页获取资源管理下的所有设备列表为例。

//初始化ListDevices的请求类。
ListDevicesRequest request = new ListDevicesRequest();
request.setMaxResults(10);  //分页参数,每页获取10行。
request.setDeviceFormName("网络设备");  //设备形态名称,在实际使用中,请按照您实际设备形态编写。
//使用request实例调用ListDevices接口,且返回参数为对应的Response实例。
ListDevicesResponse response = authClient.listDevices(request);
//其他代码。