You need to enable JavaScript to run this app.
文档中心
API 网关

API 网关

复制全文
下载 pdf
路由管理
GetCustomDomain - 查询自定义域名详情
复制全文
下载 pdf
GetCustomDomain - 查询自定义域名详情
查询自定义域名详情。​
请求说明​
API 网关已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地域,选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apig.cn-beijing.volcengineapi.com?Action=GetCustomDomain&Version=2021-03-03​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
GetCustomDomain​
接口名称。当前 API 的名称为 GetCustomDomain。​
Version​
String​
是​
2021-03-03​
接口版本。当前 API 的版本为 2021-03-03。​
Id​
String​
是​
d****​
自定义域名 ID。您可以通过 ListCustomDomains 查询自定义域名 ID。​
​
请求示例​
​
POST https://apig.cn-beijing.volcengineapi.com?Action=GetCustomDomain&Version=2021-03-03​
Content-Type: application/json​
{​
"Id": "d****"​
}​
​
返回参数​
​
参数​
类型​
示例值​
描述​
CustomDomain​
-​
自定义域名详情。​
​
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​
自定义域名的状态,取值:​
  • CreationSuccess:配置成功。​
  • 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:否。​
​
返回示例​
​
Content-Type: application/json​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "GetCustomDomain",​
"Version": "2021-03-03",​
"Service": "apig",​
"Region": "cn-beijing"​
},​
"Result": {​
"CustomDomain": {​
"Id": "d****",​
"Domain": "volcengine.com",​
"Status": "Creating",​
"Comments": "example",​
"Protocol": [​
"HTTP",​
"HTTPS"​
],​
"ServiceId": "sd84****",​
"CreateTime": "2025-01-01T00:00:00+08:00",​
"UpdateTime": "2025-01-01T00:00:00+08:00",​
"SSLRedirect": true,​
"CertificateId": "cert-c88****"​
}​
}​
}​
​
错误码​
本接口无特有的错误码。更多信息请参见 公共错误码。​
最近更新时间:2026.07.29 10:20:01
这个页面对您有帮助吗?
有用
有用
无用
无用