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

文档中心

立即注册

导航

标签管理

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

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

说明

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

调用说明

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

前提条件

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

调用示例

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

创建标签 CreateTag

您可以调用 CreateTag 接口创建标签 CreateTag。详细的参数说明可参见 CreateTag 接口文档。

接口调用示例如下所示。

package com.volcengine.ACEP.demo;

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

public class CreateTagDemo {

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

    CreateTagBody body = new CreateTagBody();

    // 业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
    body.setProductId("1608456935646xxxxxx");
    // 标签名称。
    body.setTagName("TEST");
    // 标签描述。
    body.setTagDesc("tagfortest");

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

更新标签 UpdateTag

您可以调用 UpdateTag 接口更新标签 UpdateTag。详细的参数说明可参见 UpdateTag 接口文档。

接口调用示例如下所示。

package com.volcengine.ACEP.demo;

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

public class UpdateTagDemo {

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

    UpdateTagBody body = new UpdateTagBody();

    // 标签 ID，可通过调用 ListTag 接口获取。
    body.setTagId("7269751760565xxxxxx");
    // 业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
    body.setProductId("1608456935646xxxxxx");
    // 标签名称。
    body.setTagName("TEST10");
    // 标签描述。
    body.setTagDesc("updatedtagfortest");

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

删除标签 DeleteTag

您可以调用 DeleteTag 接口删除标签 DeleteTag。详细的参数说明可参见 DeleteTag 接口文档。

接口调用示例如下所示。

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

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

    DeleteTagBody body = new DeleteTagBody();

    // 标签 ID 列表，可通过调用 ListTag 接口获取。
    List<String> TagIdList = new ArrayList<>();

    TagIdList.add("7307142253976xxxxxx");
    body.setTagIdList(TagIdList);
    // 业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
    body.setProductId("1608456935646xxxxxx");

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

实例打标签 AttachTag

您可以调用 AttachTag 接口实例打标签 AttachTag。详细的参数说明可参见 AttachTag 接口文档。

接口调用示例如下所示。

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

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

    AttachTagBody body = new AttachTagBody();

    // 标签 ID，可通过调用 ListTag 接口获取，空值为删除实例已绑定标签。
    body.setTagId("7269751760565xxxxxx");

    // 实例 ID 列表，可通过 ListPod 接口获取，最大长度为 1000。
    List<String> PodIdList = new ArrayList<>();

    PodIdList.add("7307097619996xxxxxx");
    PodIdList.add("7307097326618xxxxxx");
    body.setPodIdList(PodIdList);
    // 业务 ID，可在「云手机控制台-业务管理-业务详情」中获取。
    body.setProductId("1608456935646xxxxxx");

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

您可以调用 ListTag 接口查询标签列表 ListTag。详细的参数说明可参见 ListTag 接口文档。

接口调用示例如下所示。

package com.volcengine.ACEP.demo;

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

public class ListTagDemo {

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

    ListTagQuery query = new ListTagQuery();

    // 业务 ID，可在**云手机控制台 > 业务管理 > 业务详情**中获取。
    query.setProductId("1608456935646xxxxxx");
    // 筛选条件，标签名称，精确搜索。
    query.setTagName("test01");
    // 筛选条件，标签名称，模糊搜索。
    query.setTagNameFuzzy("01");
    // 查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 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 {
      ListTagRes resp = service.listTag(query);
      System.out.println(resp);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}