文档中心

API 网关

路由管理

ListCustomDomains - 批量查询自定义域名

批量查询自定义域名列表。

请求说明

API 网关已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求地址：https://apig.cn-beijing.volcengineapi.com?Action=ListCustomDomains&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListCustomDomains	接口名称。当前 API 的名称为 ListCustomDomains。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
PageNumber	Long	否	1	分页查询的页号。取值最小限制为 1，默认值为 1。
PageSize	Long	否	10	每页个数。取值范围为 0~100，默认值为 10。
ServiceId	String	否	sd84****	自定义域名所属服务 ID。您可以通过 ListGatewayServices 查询服务 ID。
GatewayId	String	否	gd8****	自定义的域名所属网关 ID。您可以通过 ListGateways 查询网关实例 ID。

请求示例

返回参数

参数	类型	示例值	描述
Total	Long	10	过滤后的总个数。
Items	Array of CustomDomainResponse	-	自定义域名列表。

CustomDomainResponse

参数	类型	示例值	描述
Id	String	d****	自定义域名 ID。
Domain	String	volcengine.com	自定义域名。
Protocol	Array of String	["HTTP","HTTPS"]	协议类型，取值： HTTP。 HTTPS。
CertificateId	String	cert-c88****	证书 ID。
ServiceId	String	sd84****	服务 ID。
Status	String	Creating	自定义域名的状态，取值： Creating：配置中。 CreationFailed：配置失败。 Deleting：删除中。 DeletionFailed：删除失败。 Verified：正常。
Comments	String	example	自定义域名的备注信息。
CreateTime	String	2025-01-01T00:00:00+08:00	自定义域名的创建时间。标准 RFC3339 格式的 UTC+8 时间。
UpdateTime	String	2025-01-01T00:00:00+08:00	自定义域名的更新时间。标准 RFC3339 格式的 UTC+8 时间。
SSLRedirect	Boolean	true	是否重定向到 HTTPS。取值： true：是。 false：否。

返回示例

错误码

本接口无特有的错误码。更多信息请参见公共错误码。

最近更新时间：2026.07.29 10:20:01

这个页面对您有帮助吗？

有用

无用