云机管理--云手机-火山引擎

文档中心

立即注册

导航

云机管理

最近更新时间：2024.10.29 19:42:43首次发布时间：2024.08.23 11:16:35

阅读本文，您可以获取 Java SDK 云机管理的接口调用示例，实现快速开发。

说明

本文的调用示例包含接口的部分参数。由于参数间可能存在互斥关系，在调用时，请您参考注释，进行调整。

调用说明

本文提供的接口调用示例均通过 AK 和 SK 初始化实例。
接口的参数说明和错误码等信息可通过接口文档查看。

前提条件

调用接口前，请先完成 Java SDK 的安装及初始化操作。

调用示例

本节为您介绍云机管理相关接口的功能和调用示例。

查询云机列表 ListHost

您可以调用 ListHost 接口查询云机列表 ListHost。详细的参数说明可参见 ListHost 接口文档。

接口调用示例如下所示。

package com.volcengine.ACEP.demo;

import com.volcengine.model.acep.*;
import com.volcengine.service.acep.ACEPService;

public class ListHostDemo {

  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"));

    ListHostQuery query = new ListHostQuery();

    // 业务 ID。可在**云手机控制台 > 业务管理 > 业务详情**中获取。
    query.setProductId("1749281594201xxxxxx");
    // 云机 ID。
    query.setHostId("7337159054625xxxxxx");
    // 云机 ID 列表。多个云机 ID 使用英文 , 分隔。
    query.setHostIdList("7337159054625xxxxxx,7337159054626xxxxxx");
    // 实例 ID。可通过调用 [ListPod](https://www.volcengine.com/docs/6394/1221468) 接口获取。
    query.setPodId("7332828319227xxxxxx");
    // 云机状态列表。多个云机状态使用英文 , 分隔。取值如下：
    // <li> 0：初始化 </li>
    // <li> 1：正常 </li>
    // <li> 2：退订中 </li>
    // <li> 3：异常 </li>
    // <li> 4：重置中 </li>
    // <li> 5：重启中 </li>
    query.setStatusList("1,2,3");
    // 机房 ID。
    query.setDc("tjtj-ctcucm-02-xxxxxxxx");
    // 云机所在的大区 ID。
    // <li> 当资源所在区域选择中国大陆，即 VolcRegion 设置为 inner 时，该参数可选值包含： </li>
    // <li> cn-north：华北 </li>
    // <li> cn-south：华南 </li>
    // <li> cn-east：华东 </li>
    // <li> cn-middle：华中 </li>
    // <li> cn-southwest：西南 </li>
    // <li> 当资源所在区域选择中国香港，即 VolcRegion 设置为 cn-hongkong-pop 时，该参数可选值为 cn-hongkong-pop。 </li>
    query.setRegion("cn-north");
    // 云手机实例规格 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");
    // 资源所在的物理区域，包含以下选项：
    // inner：中国大陆（默认值）
    // cn-hongkong-pop：中国香港
    query.setVolcRegion("inner");
    // 资源 ID。
    query.setResourceSetId("Android_cloudxxxxx");
    // 云机运维授权状态：
    // <li> 1：未授权； </li>
    // <li> 2：已授权。 </li>
    query.setAuthorityStatus(1);
    // 实例 ID 列表，多个实例 ID 使用英文,分隔
    query.setPodIdList("7337159054625xxxxxx,7337159054626xxxxxx");
    // 查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 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 {
      ListHostRes resp = service.listHost(query);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

查询云机详情 DetailHost

您可以调用 DetailHost 接口查询云机详情 DetailHost。详细的参数说明可参见 DetailHost 接口文档。

接口调用示例如下所示。

package com.volcengine.ACEP.demo;

import com.volcengine.model.acep.*;
import com.volcengine.service.acep.ACEPService;

public class DetailHostDemo {

  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"));

    DetailHostQuery query = new DetailHostQuery();

    // 业务 ID。可在**云手机控制台 > 业务管理 > 业务详情**中获取。
    query.setProductId("1749281594201xxxxxx");
    // 云机 ID。可通过调用 [ListHost](https://www.volcengine.com/docs/6394/1221480) 接口获取。
    query.setHostId("7337159054625xxxxxx");

    try {
      DetailHostRes resp = service.detailHost(query);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

更新云机 UpdateHost

您可以调用 UpdateHost 接口更新云机 UpdateHost。详细的参数说明可参见 UpdateHost 接口文档。

接口调用示例如下所示。

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 UpdateHostDemo {

  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"));

    UpdateHostBody body = new UpdateHostBody();

    // 业务 ID。可在**云手机控制台 > 业务管理 > 业务详情**中获取。
    body.setProductId("1749281594201xxxxxx");

    // 云机 ID 列表。可通过调用 [ListHost](https://www.volcengine.com/docs/6394/1221480) 接口获取。
    List<String> HostIdList = new ArrayList<>();

    HostIdList.add("7337159054625xxxxxx");
    HostIdList.add("7337159054626xxxxxx");
    body.setHostIdList(HostIdList);
    // 云机上运行实例的规格 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>
    body.setConfigurationCode("ultimate");

    try {
      UpdateHostRes resp = service.updateHost(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

重启云机 RebootHost

您可以调用 RebootHost 接口重启云机 RebootHost。详细的参数说明可参见 RebootHost 接口文档。

接口调用示例如下所示。

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 RebootHostDemo {

  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"));

    RebootHostBody body = new RebootHostBody();

    // 业务 ID。可在**云手机控制台 > 业务管理 > 业务详情**中获取。
    body.setProductId("1749281594201xxxxxx");

    // 云机 ID 列表。可通过调用 [ListHost](https://www.volcengine.com/docs/6394/1221480) 接口获取。
    List<String> HostIdList = new ArrayList<>();

    HostIdList.add("7337159054625xxxxxx");
    HostIdList.add("7337159054626xxxxxx");
    body.setHostIdList(HostIdList);
    // 是否强制重启。取值如下：
    // <li> true：（默认）不会将云机实例主动关机。 </li>
    // <li> false：会将云机实例强制重启。 </li>
    body.setForce(true);

    try {
      RebootHostRes resp = service.rebootHost(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

重置云机 ResetHost

您可以调用 ResetHost 接口重置云机 ResetHost。详细的参数说明可参见 ResetHost 接口文档。

接口调用示例如下所示。

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 ResetHostDemo {

  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"));

    ResetHostBody body = new ResetHostBody();

    // 业务 ID。可在**云手机控制台 > 业务管理 > 业务详情**中获取。
    body.setProductId("1749281594201xxxxxx");

    // 云机 ID 列表。可通过调用 [ListHost](https://www.volcengine.com/docs/6394/1221480) 接口获取。
    List<String> HostIdList = new ArrayList<>();

    HostIdList.add("7337159054625xxxxxx");
    HostIdList.add("7337159054626xxxxxx");
    body.setHostIdList(HostIdList);

    try {
      ResetHostRes resp = service.resetHost(body);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}