阅读本文,您可以获取 Java SDK 资源管理的接口调用示例,实现快速开发。
说明
本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。
调用接口前,请先完成 Java SDK 的安装及初始化操作。
本节为您介绍资源管理相关接口的功能和调用示例。
您可以调用 ListConfiguration 接口查询套餐列表 ListConfiguration。详细的参数说明可参见 ListConfiguration 接口文档。
接口调用示例如下所示。
package com.volcengine.ACEP.demo; import com.volcengine.model.acep.*; import com.volcengine.service.acep.ACEPService; public class ListConfigurationDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY ACEPService service = ACEPService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); ListConfigurationQuery query = new ListConfigurationQuery(); // 业务 ID,可在「云手机控制台-业务管理-业务详情」中获取。 query.setProductId("1591495366954xxxxxx"); // 配置资源类型: // <li> 1:实例 </li> // <li> 2:存储 </li> // <li> 3:公网 </li> query.setResourceClass(1); // 云机上运行的实例规格 ID,包含以下取值: // <li> ultimate:旗舰型 </li> // <li> enhanced:加强型 </li> // <li> common:通用型 </li> // <li> sample:入门型 </li> // <li> basic:基础型 </li> // <li> elementary:低配型 </li> // <li> ultimatePlus:旗舰型Plus </li> // <li> enhancedPlus:加强型Plus </li> // <li> commonPlus:通用型Plus </li> // <li> samplePlus:入门型Plus </li> // <li> basicPlus:基础型Plus </li> // <li> elementaryPlus:低配型Plus </li> // 本地存储方案除上述 12 种规格外,还包含以下 6 个取值: // <li> ultimatePro:旗舰型Pro </li> // <li> enhancedPro:加强型Pro </li> // <li> commonPro:通用型Pro </li> // <li> samplePro:入门型Pro </li> // <li> basicPro:基础型Pro </li> // <li> elementaryPro:低配型Pro </li> query.setConfigurationCode("ultimate"); // 查询结果的起始位置,用于指定从哪一条记录开始返回数据。例如,若 Offset 为 10,则表示从第 11 条记录开始。默认值为 0。 // note: // 可与 Count 配合使用。假设当前数据集的记录总数为 200 条,如需查询第 101~150 条数据,需设置 Offset 为 100,Count 为 50。 query.setOffset((long) 0); // 单次查询返回的最大记录数,用于控制每次查询返回的数据量。例如,若 Count 为 100,则表示在查询数据时,系统将每次返回 100 条记录。 // note: // 可与 Offset 配合使用。假设当前数据集的记录总数为 200 条,如需查询第 101~150 条数据,需设置 Offset 为 100,Count 为 50。 query.setCount((long) 10); try { ListConfigurationRes resp = service.listConfiguration(query); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 ListPodResource 接口查询实例资源列表 ListPodResource。详细的参数说明可参见 ListPodResource 接口文档。
接口调用示例如下所示。
package com.volcengine.ACEP.demo; import com.volcengine.model.acep.*; import com.volcengine.service.acep.ACEPService; public class ListPodResourceDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY ACEPService service = ACEPService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); ListPodResourceQuery query = new ListPodResourceQuery(); // 业务 ID,可在「云手机控制台-业务管理-业务详情」中获取。 query.setProductId("1591495366954xxxxxx"); // 云手机实例规格 ID,包含以下取值: // <li> ultimate:旗舰型 </li> // <li> enhanced:加强型 </li> // <li> common:通用型 </li> // <li> sample:入门型 </li> // <li> basic:基础型 </li> // <li> elementary:低配型 </li> // <li> ultimatePlus:旗舰型Plus </li> // <li> enhancedPlus:加强型Plus </li> // <li> commonPlus:通用型Plus </li> // <li> samplePlus:入门型Plus </li> // <li> basicPlus:基础型Plus </li> // <li> elementaryPlus:低配型Plus </li> // 本地存储方案除上述 12 种规格外,还包含以下 6 个取值: // <li> ultimatePro:旗舰型Pro </li> // <li> enhancedPro:加强型Pro </li> // <li> commonPro:通用型Pro </li> // <li> samplePro:入门型Pro </li> // <li> basicPro:基础型Pro </li> // <li> elementaryPro:低配型Pro </li> query.setConfigurationCode("ultimate"); // 实例所属机房的 ID。可通过「云手机控制台-实例管理-实例列表」中获取。 query.setDc("gdsz-ctcucm-01-xxxxxxxx"); // 根据镜像 ID,查询预热完成的实例数量。 query.setImageId("img-6890xxxx"); // 查询结果的起始位置,用于指定从哪一条记录开始返回数据。例如,若 Offset 为 10,则表示从第 11 条记录开始。默认值为 0。 // note: // 可与 Count 配合使用。假设当前数据集的记录总数为 200 条,如需查询第 101~150 条数据,需设置 Offset 为 100,Count 为 50。 query.setOffset((long) 0); // 单次查询返回的最大记录数,用于控制每次查询返回的数据量。例如,若 Count 为 100,则表示在查询数据时,系统将每次返回 100 条记录。 // note: // 可与 Offset 配合使用。假设当前数据集的记录总数为 200 条,如需查询第 101~150 条数据,需设置 Offset 为 100,Count 为 50。 query.setCount((long) 10); try { ListPodResourceRes resp = service.listPodResource(query); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 UpdatePodResourceApplyNum 接口更新订购实例数量 UpdatePodResourceApplyNum。详细的参数说明可参见 UpdatePodResourceApplyNum 接口文档。
接口调用示例如下所示。
package com.volcengine.ACEP.demo; import com.volcengine.model.acep.*; import com.volcengine.service.acep.ACEPService; public class UpdatePodResourceApplyNumDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY ACEPService service = ACEPService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); UpdatePodResourceApplyNumBody body = new UpdatePodResourceApplyNumBody(); // 实例所归属的业务 ID,可在「云手机控制台-业务管理-业务详情」中获取。 body.setProductId("1591495366954xxxxxx"); // 实例资源组 ID: // <li> 如指定,则优先级大于 ConfigurationCode 和 Dc </li> // <li> 如不指定,则 ConfigurationCode 和 Dc 必填,由 ConfigurationCode + Dc 确定 ResourceSetId </li> body.setResourceSetId("Android_cloud728380418xxxxxxxxxx"); // 云手机实例规格 ID,如未指定 ResourceSetId,则此项必填。 // <li> ultimate:旗舰型 </li> // <li> enhanced:加强型 </li> // <li> common:通用型 </li> // <li> sample:入门型 </li> // <li> basic:基础型 </li> // <li> elementary:低配型 </li> // <li> ultimatePlus:旗舰型Plus </li> // <li> enhancedPlus:加强型Plus </li> // <li> commonPlus:通用型Plus </li> // <li> samplePlus:入门型Plus </li> // <li> basicPlus:基础型Plus </li> // <li> elementaryPlus:低配型Plus </li> // 本地存储方案除上述 12 种规格外,还包含以下 6 个取值: // <li> ultimatePro:旗舰型Pro </li> // <li> enhancedPro:加强型Pro </li> // <li> commonPro:通用型Pro </li> // <li> samplePro:入门型Pro </li> // <li> basicPro:基础型Pro </li> // <li> elementaryPro:低配型Pro </li> body.setConfigurationCode("ultimate"); body.setDc("gdsz-ctcucm-01-xxxxxxxx"); body.setApplyNum((long) 2); try { UpdatePodResourceApplyNumRes resp = service.updatePodResourceApplyNum( body ); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 ListResourceQuota 接口查询资源配额 ListResourceQuota。详细的参数说明可参见 ListResourceQuota 接口文档。
接口调用示例如下所示。
package com.volcengine.ACEP.demo; import com.volcengine.model.acep.*; import com.volcengine.service.acep.ACEPService; public class ListResourceQuotaDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY ACEPService service = ACEPService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); ListResourceQuotaQuery query = new ListResourceQuotaQuery(); // 业务 ID,可在「云手机控制台-业务管理-业务详情」中获取。 query.setProductId("1591495366954xxxxxx"); try { ListResourceQuotaRes resp = service.listResourceQuota(query); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 GetProductResource 接口查询业务存储资源 GetProductResource。详细的参数说明可参见 GetProductResource 接口文档。
接口调用示例如下所示。
package com.volcengine.ACEP.demo; import com.volcengine.model.acep.*; import com.volcengine.service.acep.ACEPService; public class GetProductResourceDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY ACEPService service = ACEPService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); GetProductResourceQuery query = new GetProductResourceQuery(); // 业务 ID,可在「云手机控制台-业务管理-业务详情」中获取。 query.setProductId("1591495366954xxxxxx"); // 资源所在的物理区域,包含以下选项: // <li> inner:中国大陆(默认值) </li> // <li> cn-hongkong-pop:中国香港 </li> query.setVolcRegion("inner"); try { GetProductResourceRes resp = service.getProductResource(query); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 UpdateProductResource 接口更新业务存储资源 UpdateProductResource。详细的参数说明可参见 UpdateProductResource 接口文档。
接口调用示例如下所示。
package com.volcengine.ACEP.demo; import com.volcengine.model.acep.*; import com.volcengine.service.acep.ACEPService; public class UpdateProductResourceDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY ACEPService service = ACEPService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); UpdateProductResourceBody body = new UpdateProductResourceBody(); // 实例所归属的业务 ID,可在「云手机控制台-业务管理-业务详情」中获取。 body.setProductId("1591495366954xxxxxx"); // 修改后,需订购的存储资源总容量,单位 GB。修改后的存储容量不能小于已使用的存储容量。 body.setApplyDataSize(760); // 资源所在的物理区域,包含以下选项: // <li> inner:中国大陆(默认值) </li> // <li> cn-hongkong-pop:中国香港 </li> body.setVolcRegion("inner"); try { UpdateProductResourceRes resp = service.updateProductResource(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 SubscribeResourceAuto 接口自动下单订购实例 SubscribeResourceAuto。详细的参数说明可参见 SubscribeResourceAuto 接口文档。
接口调用示例如下所示。
package com.volcengine.ACEP.demo; import com.volcengine.model.acep.*; import com.volcengine.service.acep.ACEPService; import java.util.ArrayList; import java.util.List; public class SubscribeResourceAutoDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY ACEPService service = ACEPService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); SubscribeResourceAutoBody body = new SubscribeResourceAutoBody(); // 业务 ID。您可在**云手机控制台 > 业务管理 > 业务详情**中获取。 body.setProductId("1749281594201xxxxxx"); // 订购配置单列表。 List<com.volcengine.model.acep.v20231030.RequestPreOrder> PreOrderList = new ArrayList<>(); com.volcengine.model.acep.v20231030.RequestPreOrder PreOrderList1 = new com.volcengine.model.acep.v20231030.RequestPreOrder(); PreOrderList.add(PreOrderList1); body.setPreOrderList(PreOrderList); // 是否开启自动续费。取值如下: // <li> true:开启自动续费。 </li> // <li> false:(默认)不开启自动续费。 </li> body.setAutoRenew(true); // 订购请求的唯一标识。您可根据自身业务需求,自定义设置订购请求的唯一标识。 // note: // 防止由于网络等原因造成重复请求,同一 RoundId 在 1 天内只可使用一次。 body.setRoundId("r1234"); try { SubscribeResourceAutoRes resp = service.subscribeResourceAuto(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 RenewResourceAuto 接口自动下单续订实例 RenewResourceAuto。详细的参数说明可参见 RenewResourceAuto 接口文档。
接口调用示例如下所示。
package com.volcengine.ACEP.demo; import com.volcengine.model.acep.*; import com.volcengine.service.acep.ACEPService; import java.util.ArrayList; import java.util.List; public class RenewResourceAutoDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY ACEPService service = ACEPService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); RenewResourceAutoBody body = new RenewResourceAutoBody(); // 业务 ID。您可在**云手机控制台 > 业务管理 > 业务详情**中获取。 body.setProductId("1749281594201xxxxxx"); // 订购请求的唯一标识。 // note: // 防止由于网络等原因造成重复请求,同一 RoundId 在 1 天内只可使用一次。 body.setRoundId("r1234"); // 并发实例资源续订配置列表。 List< com.volcengine.model.acep.v20231030.RequestRenewResourcePreorder > PreOrderList = new ArrayList<>(); com.volcengine.model.acep.v20231030.RequestRenewResourcePreorder PreOrderList1 = new com.volcengine.model.acep.v20231030.RequestRenewResourcePreorder(); PreOrderList.add(PreOrderList1); body.setPreOrderList(PreOrderList); try { RenewResourceAutoRes resp = service.renewResourceAuto(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 ListPodResourceSet 接口查询实例资源组列表 ListPodResourceSet。详细的参数说明可参见 ListPodResourceSet 接口文档。
接口调用示例如下所示。
package com.volcengine.ACEP.demo; import com.volcengine.model.acep.*; import com.volcengine.service.acep.ACEPService; public class ListPodResourceSetDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY ACEPService service = ACEPService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); ListPodResourceSetQuery query = new ListPodResourceSetQuery(); // 业务 ID, 可在**云手机控制台 > 业务管理 > 业务详情**中获取。 query.setProductId("1591495366954xxxxxx"); // 资源组 ID,精确搜索。 query.setResourceSetId("Android_cloud728306995xxxxxxxxxx"); // 云手机实例规格 ID。取值如下: // <li> ultimate:旗舰型 </li> // <li> enhanced:加强型 </li> // <li> common:通用型 </li> // <li> sample:入门型 </li> // <li> basic:基础型 </li> // <li> elementary:低配型 </li> // <li> ultimatePlus:旗舰型Plus </li> // <li> enhancedPlus:加强型Plus </li> // <li> commonPlus:通用型Plus </li> // <li> samplePlus:入门型Plus </li> // <li> basicPlus:基础型Plus </li> // <li> elementaryPlus:低配型Plus </li> // 本地存储方案除上述 12 种规格外,还包含以下 6 个取值: // <li> ultimatePro:旗舰型Pro </li> // <li> enhancedPro:加强型Pro </li> // <li> commonPro:通用型Pro </li> // <li> samplePro:入门型Pro </li> // <li> basicPro:基础型Pro </li> // <li> elementaryPro:低配型Pro </li> query.setConfigurationCode("ultimate"); // 机房 ID,精确搜索。可通过 [ListDc](https://www.volcengine.com/docs/6394/1221465) 接口获取。 query.setDc("gdsz-ctcucm-01-xxxxxxxx"); // 资源所在的物理区域,包含以下选项: // <li> inner:中国大陆(默认值) </li> // <li> cn-hongkong-pop:中国香港 </li> query.setVolcRegion("inner"); // 查询结果的起始位置,用于指定从哪一条记录开始返回数据。例如,若 Offset 为 10,则表示从第 11 条记录开始。默认值为 0。 // note: // 可与 Count 配合使用。假设当前数据集的记录总数为 200 条,如需查询第 101~150 条数据,需设置 Offset 为 100,Count 为 50。 query.setOffset((long) 0); // 单次查询返回的最大记录数,用于控制每次查询返回的数据量。例如,若 Count 为 100,则表示在查询数据时,系统将每次返回 100 条记录。 // note: // 可与 Offset 配合使用。假设当前数据集的记录总数为 200 条,如需查询第 101~150 条数据,需设置 Offset 为 100,Count 为 50。 query.setCount((long) 10); try { ListPodResourceSetRes resp = service.listPodResourceSet(query); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 UnsubscribeHostResource 接口退订后付费云机资源 UnsubscribeHostResource。详细的参数说明可参见 UnsubscribeHostResource 接口文档。
接口调用示例如下所示。
package com.volcengine.ACEP.demo; import com.volcengine.model.acep.*; import com.volcengine.service.acep.ACEPService; import java.util.ArrayList; import java.util.List; public class UnsubscribeHostResourceDemo { public static void main(String[] args) { // 强烈建议不要把 VOLC_ACCESSKEY 和 VOLC_SECRETKEY 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 VOLC_ACCESSKEY 和 VOLC_SECRETKEY,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 VOLC_ACCESSKEY 和 VOLC_SECRETKEY ACEPService service = ACEPService.getInstance(); service.setAccessKey(System.getenv("VOLC_ACCESSKEY")); service.setSecretKey(System.getenv("VOLC_SECRETKEY")); UnsubscribeHostResourceBody body = new UnsubscribeHostResourceBody(); // 业务 ID。您可在**云手机控制台 > 业务管理 > 业务详情**中获取。 body.setProductId("177500569***840"); // 云机 ID 列表。可通过 [ListHost](https://www.volcengine.com/docs/6394/1221480) 接口获取。 List<String> HostIdList = new ArrayList<>(); HostIdList.add("host-73561748***2524"); body.setHostIdList(HostIdList); // 是否允许强制退订。取值如下: // <li> false:(默认)不允许强制退订。 </li> // <li> true:允许强制退订。 </li> // note: // 节点资源存在实例时依然可以退订,并主动删除相关实例数据。 body.setForce(true); try { UnsubscribeHostResourceRes resp = service.unsubscribeHostResource(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }