文档首页/ Web应用防火墙 WAF/ API参考/ API/ 安全总览/ 查询泛域名的防护事件中的子域名,仅泛域名存在子域名 - ListOverviewsHostDomains
更新时间:2026-03-26 GMT+08:00
分享

查询泛域名的防护事件中的子域名,仅泛域名存在子域名 - ListOverviewsHostDomains

功能介绍

查询泛域名的防护事件中的子域名,仅泛域名存在子域名

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/waf/overviews/{host_id}/domains

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

host_id

String

参数解释:

泛域名id,通过 ”查询独享模式域名列表“(ListPremiumHost)或者 “查询云模式防护域名列表” (ListHost)接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。

from

Long

参数解释:

起始时间(毫秒时间戳),需要和to同时使用

约束限制:

from <= to

取值范围:

from ~ to 最大范围30天

默认取值:

不涉及

to

Long

参数解释:

结束时间(毫秒时间戳),需要和from同时使用

约束限制:

from ~ to 最大范围30天

取值范围:

不能超过当天的结束时间

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total

Integer

子域名数量

items

Array of strings

子域名列表

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表6 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表8 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

查询项目id为project_id,时间从2022-05-19 00:00:00到2022-06-17 11:14:41,泛域名id为“1bac09440a814aa98ed08302c580a48b”下的子域名

GET https://{Endpoint}/v1/{project_id}/waf/overviews/1bac09440a814aa98ed08302c580a48b/domains?enterprise_project_id=0&from=1652889600354&to=1655435681354

响应示例

状态码:200

ok

{
  "total" : 1,
  "items" : [ "www.test.com" ]
}

状态码

状态码

描述

200

ok

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码

相关文档