ListCustomHostnames - 查询 SaaS 域名列表 - 边缘安全加速

查询站点下的 SaaS 域名列表，包括 SaaS 域名的 ID、状态、域名验证信息等。支持根据 SaaS 域名的名称、站点 ID、绑定的记录 ID 等条件过滤。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SiteId	integer	是	站点 ID，可通过调用 ListSites 接口获取。	744571165985008
RecordId	integer	否	绑定的记录 ID，可以通过 ListRecords 获取。	1234567890123
Hostname	string	否	SaaS 域名。	custom.site.com
NameMatchType	string	否	SaaS 域名的搜索匹配模式。默认为精确匹配。 prefix：前缀匹配。 suffix：后缀匹配。 exact：精确匹配。 fuzzy：模糊匹配。	exact
Status	string	否	SaaS 域名状态。 pending: 待验证。 active: 已激活。 conflicted: 被占用。 offline: 已下线。	active
PageNumber	integer	否	页面页码（从 1 开始），默认 1。	1
PageSize	integer	否	页面大小，默认 100，最大 500。	100

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID，阿里云为该请求生成的唯一标识符。	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	integer	页面页码。	1
PageSize	integer	页面大小。	100
TotalCount	integer	SaaS 域名总个数。	10
Hostnames	array<object>	查询到的 SaaS 域名列表。
	object	单个 SaaS 域名信息。
HostnameId	integer	SaaS 域名的 ID。	1234567890123
Hostname	string	SaaS 域名。	custom.site.com
SiteId	integer	站点 ID。	890601022130656
SiteName	string	站点名称。	example.com
RecordId	integer	记录 ID。	3386032455886912
RecordName	string	记录名称。	origin.example.com
Status	string	SaaS 域名状态。 pending: 待验证。 active: 已激活。 conflicted: 被占用。 offline: 已下线。	active
SslFlag	string	SSL 开关。 on: 开启 SSL。 off: 关闭 SSL。	on
CertType	string	证书类型。 free: 免费证书。 upload: 上传证书。 cas: 云盾证书。	free
CertHttpKey	string	证书验证 HTTP 地址。	http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc
CertHttpValue	string	证书验证 HTTP 内容。	jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0
CertTxtKey	string	证书验证 TXT 名称。	_acme-challenge.custom.site.com
CertTxtValue	string	证书验证 TXT 内容。	lcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM
VerifyHost	string	域名验证 TXT 名称。	_esa_custom_hostname.custom.site.com
VerifyCode	string	域名验证 TXT 内容。	verify_16ab7f4d389d4dff6655f995c6a997bd
CertStatus	string	证书状态。 OK: 正常。 Applying: 申请中。 ApplyFailed: 申请失败。 Expiring: 即将过期。 Expired: 已过期。	OK
CertNotAfter	string	证书过期时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2026-04-19T11:15:20Z
CertApplyMessage	string	免费证书申请错误说明。	canceled
CertApplyCode	integer	免费证书申请错误码。	2
OfflineReason	string	SaaS 域名被下线的原因。 expiration_ arrears：订阅套餐到期或账号欠费。 internally_disabled：被系统内部停用。 missing_icp：域名缺少 ICP。 content_violation：内容违规。 proactively_disabled：您主动停用或您设置的用量封顶停用。	missing_icp
ConflictWith	string	SaaS 域名被占用的原因。 existing_custom_hostname: 与现有 SaaS 域名冲突。 existing_record: 与现有站点记录冲突。 existing_load_balancer: 与现有负载均衡器冲突。 existing_origin_pool: 与现有源地址池冲突。	existing_custom_hostname
CreateTime	string	SaaS 域名的创建时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2026-04-19T11:15:20Z
UpdateTime	string	SaaS 域名的更新时间，日期格式按照 ISO8601 表示法，并使用 UTC 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。	2026-04-19T11:15:20Z

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": 1,
  "PageSize": 100,
  "TotalCount": 10,
  "Hostnames": [
    {
      "HostnameId": 1234567890123,
      "Hostname": "custom.site.com",
      "SiteId": 890601022130656,
      "SiteName": "example.com",
      "RecordId": 3386032455886912,
      "RecordName": "origin.example.com",
      "Status": "active",
      "SslFlag": "on",
      "CertType": "free",
      "CertHttpKey": "http://custom.site.com/.well-known/acme-challenge/jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc",
      "CertHttpValue": "jLmMHlEaZ3jb352Qo3ciaSoAC8KZ5Hk0F-4_1xLQtgc.GridYdfJJB5PgFEL-t89XfaFvMPB4f2-I9fwLpKl6e0",
      "CertTxtKey": "\t\n_acme-challenge.custom.site.com\n",
      "CertTxtValue": "\t\nlcKYad3UQXgrZLvMm_6TBUYKK4xTkGmninV0Mzx4gjM\n",
      "VerifyHost": "_esa_custom_hostname.custom.site.com\n",
      "VerifyCode": "verify_16ab7f4d389d4dff6655f995c6a997bd\n",
      "CertStatus": "OK",
      "CertNotAfter": "2026-04-19T11:15:20Z\n",
      "CertApplyMessage": "canceled",
      "CertApplyCode": 2,
      "OfflineReason": "missing_icp",
      "ConflictWith": "existing_custom_hostname",
      "CreateTime": "2026-04-19T11:15:20Z",
      "UpdateTime": "2026-04-19T11:15:20Z"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InternalException	Failed to call the service. Try again later or contact technical support.	调用服务失败，请稍后重试或联系客服咨询详情。
400	InvalidParameter	The specified parameter is invalid.	输入参数规范校验失败。
404	CustomHostname.NotFound	The custom hostname does not exist. Modify it and try again.	该自定义主机名不存在，请调整后重试。
404	CustomHostname.ApplyCertFailed	Fail to apply a free cert for custom hostname. Please try again later.
404	CustomHostname.SetCertFailed	Fail to deploy a cert for custom hostname. Please try again later.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。