最近更新时间:2024.04.15 11:36:59
首次发布时间:2023.12.28 21:21:51
阅读本文,您可以获取 Java SDK 域名管理的接口调用示例,实现快速开发。
说明
本文的调用示例包含接口的全部参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。
调用接口前,请先完成 Java SDK 的安装及初始化操作
本节为您介绍域名管理相关接口的功能和调用示例。
您可以调用 CreateDomain 接口添加域名。详细的参数说明可参见 CreateDomain 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.CreateDomainBody; import com.volcengine.model.live.v20230101.CreateDomainRes; import com.volcengine.service.live.v20230101.LiveService; public class CreateDomainDemo { public static void main(String[] args) { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("ACCESS_KEY_ID")); service.setSecretKey(System.getenv("ACCESS_KEY_SECRET")); CreateDomainBody body = new CreateDomainBody(); // 待添加到视频直播服务进行加速的域名,域名只能由数字(0 - 9)、字母(A - Z、a -z)和连字符(-) 组成。 body.setDomain("push.example.com"); // 域名类型,包含两种类型。 // <li> `push`:推流域名; </li> // <li> `pull-flv`:拉流域名,包含 RTMP、FLV、HLS 格式。 </li> body.setType("push"); // 域名加速区域,默认指为 `cn`,包含以下类型。 // <li> `cn`:中国大陆; </li> // <li> `cn-global`:全球; </li> // <li> `cn-oversea`:海外及港澳台。 </li> body.setRegion("cn"); try { CreateDomainRes resp = service.createDomain(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 CreateDomainV2 接口批量添加域名。详细的参数说明可参见 CreateDomainV2 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.CreateDomainV2Body; import com.volcengine.model.live.v20230101.CreateDomainV2BodyDomainsItem; import com.volcengine.model.live.v20230101.CreateDomainV2BodyTagsItem; import com.volcengine.model.live.v20230101.CreateDomainV2Res; import com.volcengine.service.live.v20230101.LiveService; import java.util.ArrayList; import java.util.List; public class CreateDomainV2Demo { public static void main(String[] args) { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("ACCESS_KEY_ID")); service.setSecretKey(System.getenv("ACCESS_KEY_SECRET")); CreateDomainV2Body body = new CreateDomainV2Body(); // 待添加到视频直播服务进行加速的域名列表信息。 // note: // 一个域名空间下最多包含 10 个域名。 List<CreateDomainV2BodyDomainsItem> CreateDomainV2BodyDomains = new ArrayList<>(); CreateDomainV2BodyDomainsItem CreateDomainV2BodyDomainsItem = new CreateDomainV2BodyDomainsItem(); // 域名名称,域名由字母(A - Z、a -z)、数字(0 - 9)和连字符(-) 组成,长度为 1 到 60 个字符。 CreateDomainV2BodyDomainsItem.setDomainName("push.example.com"); // 证书链 ID。 CreateDomainV2BodyDomainsItem.setChainID("93cb8cf3*******ece5600142"); // 域名类型,取值及含义如下所示。 // <li> `push`:推流域名; </li> // <li> `pull-flv`:拉流域名。 </li> CreateDomainV2BodyDomainsItem.setType("push"); CreateDomainV2BodyDomains.add(CreateDomainV2BodyDomainsItem); body.setDomains(CreateDomainV2BodyDomains); // 域名加速区域,包含以下类型。 // <li> `cn`:中国大陆; </li> // <li> `cn-global`:全球; </li> // <li> `cn-oversea`:海外及港澳台。 </li> body.setRegion("cn"); // 域名空间,是一组关联域名的集合,由字母(A - Z、a -z)、数字(0 - 9)和连字符(-) 组成。您可以自定义新的域名空间或调用 [ListDomainDetail](https//www.volcengine.com/docs/6469/1126815) 接口查看已有域名使用的域名空间。 body.setVhost("vhost"); // 项目名称,vhost 将归类这个项目里,仅在新创建 vhost 时需要设置。 body.setProjectName("default"); // 标签列表,vhost 将归类这个 tag 里。 List<CreateDomainV2BodyTagsItem> CreateDomainV2BodyTags = new ArrayList<>(); CreateDomainV2BodyTagsItem CreateDomainV2BodyTagsItem = new CreateDomainV2BodyTagsItem(); // 标签 Key 值。 CreateDomainV2BodyTagsItem.setKey("key001"); // 标签 Value 值。 CreateDomainV2BodyTagsItem.setValue("Valuedes"); // 标签类型,支持以下取值。 // <li> `System`:系统内置标签; </li> // <li> `Custom`:自定义标签。 </li> CreateDomainV2BodyTagsItem.setCategory("Custom"); CreateDomainV2BodyTags.add(CreateDomainV2BodyTagsItem); body.setTags(CreateDomainV2BodyTags); try { CreateDomainV2Res resp = service.createDomainV2(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 UpdateDomainVhost 接口更新域名的域名空间。详细的参数说明可参见 UpdateDomainVhost 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.UpdateDomainVhostBody; import com.volcengine.model.live.v20230101.UpdateDomainVhostRes; import com.volcengine.service.live.v20230101.LiveService; public class UpdateDomainVhostDemo { public static void main(String[] args) { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("ACCESS_KEY_ID")); service.setSecretKey(System.getenv("ACCESS_KEY_SECRET")); UpdateDomainVhostBody body = new UpdateDomainVhostBody(); // 待修改所属域名空间的的拉流/推流域名,您可以调用 [ListDomainDetail](https//www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https//console-stable.volcanicengine.com/live/main/domain/list)页面,查看域名信息。 body.setDomain("push.example.com"); // 目的域名空间,您可以调用 [ListDomainDetail](https//www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https//console-stable.volcanicengine.com/live/main/domain/list)页面,查看域名所属的域名空间信息。 body.setVhost("push.example.com"); try { UpdateDomainVhostRes resp = service.updateDomainVhost(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 DeleteDomain 接口删除域名。详细的参数说明可参见 DeleteDomain 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.DeleteDomainBody; import com.volcengine.model.live.v20230101.DeleteDomainRes; import com.volcengine.service.live.v20230101.LiveService; public class DeleteDomainDemo { public static void main(String[] args) { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("ACCESS_KEY_ID")); service.setSecretKey(System.getenv("ACCESS_KEY_SECRET")); DeleteDomainBody body = new DeleteDomainBody(); // 待删除域名,您可以调用 [ListDomainDetail](https//www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https//console-stable.volcanicengine.com/live/main/domain/list)页面,查看需要待禁用域名的信息。 body.setDomain("push.example.com"); try { DeleteDomainRes resp = service.deleteDomain(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 DisableDomain 接口禁用域名。详细的参数说明可参见 DisableDomain 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.DisableDomainBody; import com.volcengine.model.live.v20230101.DisableDomainRes; import com.volcengine.service.live.v20230101.LiveService; public class DisableDomainDemo { public static void main(String[] args) { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("ACCESS_KEY_ID")); service.setSecretKey(System.getenv("ACCESS_KEY_SECRET")); DisableDomainBody body = new DisableDomainBody(); // 待禁用域名,您可以调用 [ListDomainDetail](https//www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https//console-stable.volcanicengine.com/live/main/domain/list)页面,查看需要待禁用域名的信息。 body.setDomain("push.example.com"); try { DisableDomainRes resp = service.disableDomain(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 EnableDomain 接口启用域名。详细的参数说明可参见 EnableDomain 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.EnableDomainBody; import com.volcengine.model.live.v20230101.EnableDomainRes; import com.volcengine.service.live.v20230101.LiveService; public class EnableDomainDemo { public static void main(String[] args) { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("ACCESS_KEY_ID")); service.setSecretKey(System.getenv("ACCESS_KEY_SECRET")); EnableDomainBody body = new EnableDomainBody(); // 待启用域名,您可以调用 [ListDomainDetail](https//www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https//console-stable.volcanicengine.com/live/main/domain/list)页面,查看需要待启用域名的信息。 body.setDomain("push.example.com"); try { EnableDomainRes resp = service.enableDomain(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 DescribeDomain 接口查询域名信息。详细的参数说明可参见 DescribeDomain 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.DescribeDomainBody; import com.volcengine.model.live.v20230101.DescribeDomainRes; import com.volcengine.service.live.v20230101.LiveService; import java.util.ArrayList; import java.util.List; public class DescribeDomainDemo { public static void main(String[] args) { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("ACCESS_KEY_ID")); service.setSecretKey(System.getenv("ACCESS_KEY_SECRET")); DescribeDomainBody body = new DescribeDomainBody(); // 待查询域名信息的域名列表。 List<String> DescribeDomainBodyDomainList = new ArrayList<>(); DescribeDomainBodyDomainList.add("push.example.com"); DescribeDomainBodyDomainList.add("pull.example.com"); body.setDomainList(DescribeDomainBodyDomainList); try { DescribeDomainRes resp = service.describeDomain(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }
您可以调用 ListDomainDetail 接口查询域名列表。详细的参数说明可参见 ListDomainDetail 接口文档。
接口调用示例如下所示。
package com.volcengine.live.demo; import com.volcengine.model.live.v20230101.ListDomainDetailBody; import com.volcengine.model.live.v20230101.ListDomainDetailRes; import com.volcengine.service.live.v20230101.LiveService; import java.util.ArrayList; import java.util.List; public class ListDomainDetailDemo { public static void main(String[] args) { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET LiveService service = LiveService.getInstance(); service.setAccessKey(System.getenv("ACCESS_KEY_ID")); service.setSecretKey(System.getenv("ACCESS_KEY_SECRET")); ListDomainDetailBody body = new ListDomainDetailBody(); // 查询数据的页码,取值为 1 时表示查询第一页的数据,取值范围为 [1,1000]。 body.setPageNum(1); // 每页显示的数据条数,取值为 10 时表示每页展示 10 条域名信息,取值范围为 [1, 1000]。 body.setPageSize(10); // 域名空间列表,缺省情况下表示查询全部域名空间下的域名。 List<String> ListDomainDetailBodyVhostList = new ArrayList<>(); ListDomainDetailBodyVhostList.add("push.example.com"); ListDomainDetailBodyVhostList.add("pull.example.com"); body.setVhostList(ListDomainDetailBodyVhostList); // 域名状态列表,缺省情况下表示查询全部状态的域名。支持的取值如下所示。 // <li> `0`:正常; </li> // <li> `1`:审核中; </li> // <li> `2`:禁用,禁止使用,此时 domain 不生效; </li> // <li> `3`:删除; </li> // <li> `4`:审核被驳回。审核不通过,需要重新创建并审核; </li> // <li> `5`:欠费关停。 </li> List<Integer> ListDomainDetailBodyDomainStatusList = new ArrayList<>(); ListDomainDetailBodyDomainStatusList.add(0); ListDomainDetailBodyDomainStatusList.add(2); ListDomainDetailBodyDomainStatusList.add(3); body.setDomainStatusList(ListDomainDetailBodyDomainStatusList); // 域名类型列表,缺省情况下表示全部类型的域名。支持的取值如下所示。 // <li> `push`:推流域名; </li> // <li> `pull-flv`:拉流域名。 </li> List<String> ListDomainDetailBodyDomainTypeList = new ArrayList<>(); ListDomainDetailBodyDomainTypeList.add("push"); ListDomainDetailBodyDomainTypeList.add("pull-flv"); body.setDomainTypeList(ListDomainDetailBodyDomainTypeList); // 域名加速区域列表,缺省情况下表示查看全部。支持的取值如下所示。 // <li> `cn`:中国大陆; </li> // <li> `cn-global`:全球; </li> // <li> `cn-oversea`:海外及港澳台。 </li> List<String> ListDomainDetailBodyDomainRegionList = new ArrayList<>(); ListDomainDetailBodyDomainRegionList.add("cn"); body.setDomainRegionList(ListDomainDetailBodyDomainRegionList); // 域名名称列表,缺省情况下表示全部域名。 List<String> ListDomainDetailBodyDomainNameList = new ArrayList<>(); ListDomainDetailBodyDomainNameList.add("push.example.com"); ListDomainDetailBodyDomainNameList.add("pull.example.com"); body.setDomainNameList(ListDomainDetailBodyDomainNameList); try { ListDomainDetailRes resp = service.listDomainDetail(body); System.out.println(resp); } catch (Exception e) { e.printStackTrace(); } } }