API 网关
API 网关
文档指南
请输入
- 文档首页
API 网关API 参考路由管理ListCustomDomains - 查询自定义域名列表
复制全文
下载 pdfListCustomDomains - 查询自定义域名列表
文档反馈
问问助手批量查询自定义域名列表。
请求说明
- 请求方式：POST
- 请求地址：https://apig.cn-beijing.volcengineapi.com?Action=ListCustomDomains&Version=2021-03-03
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：ListCustomDomains
要执行的操作，取值：ListCustomDomains。
Version string 必选 示例值：2021-03-03
API的版本，取值：2021-03-03。
PageNumber long 可选 示例值：1
分页查询的页号。取值最小限制为 1，默认值为 1。
PageSize long 可选 示例值：10
每页个数。取值范围为 0~100，默认值为 10。
ServiceId string 可选 示例值：sd84****
GatewayId string 可选 示例值：gd8****
ResourceType string 可选 示例值：Console
资源类型，取值：
- Console：从控制台创建。
- Ingress：同步自 Ingress。
返回参数
Total long 示例值：10
过滤后的总个数。
Items object[] 示例值：-
自定义域名列表。
Id string 示例值：d****
自定义域名 ID。
Domain string 示例值：volcengine.com
自定义域名。
Protocol string[] 示例值：["HTTP","HTTPS"]
协议类型，取值：
- HTTP。
- HTTPS。
CertificateId string 示例值：cert-c88****
证书 ID。
ServiceId string 示例值：sd84****
服务 ID。
Status string 示例值：Creating
自定义域名的状态，取值：
- Creating：配置中。
- CreationFailed：配置失败。
- Deleting：删除中。
- DeletionFailed：删除失败。
- Verified：正常。
ResourceType string 示例值：Console
资源类型，取值：
- Console（默认值）：从控制台创建。
- Ingress：同步自 Ingress。
Comments string 示例值：example
自定义域名的备注信息。
CreateTime string 示例值：2025-01-01T00:00:00+08:00
UpdateTime string 示例值：2025-01-01T00:00:00+08:00
SSLRedirect boolean 示例值：true
是否重定向到 HTTPS。取值：
- true：是。
- false：否。
Tags object[] 示例值：-
标签。
Key string 示例值：example-key
标签键。长度限制为 1~256 个字符。
Value string 示例值：example-value
标签值。长度限制为 0~256 个字符。
请求示例
返回示例
错误码
状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidParameter | The specified parameter %s is invalid. | 请求参数值不合法。请确认参数后重试。 |
500 | InternalError | The request has failed due to an unknown error. |
最近更新时间：2026.10.28 14:59:49
这个页面对您有帮助吗？
有用
有用
无用
无用