更新时间:2024-11-18 GMT+08:00

查询防护域名列表

功能介绍

查询防护域名列表

URI

GET /v1/edgesec/configuration/domains

表1 Query参数

参数

是否必选

参数类型

描述

offset

Integer

查询列表的偏移量

limit

Integer

查询列表每一页的条数

domain_name

String

域名

policy_name

String

策略名称

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id,默认为0

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

租户token

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

total

Long

全部防护域名的数量

domain_used_quota

Long

域名已使用配额

domain_list

Array of DomainInfo objects

详细的防护域名信息

表4 DomainInfo

参数

参数类型

描述

id

String

域名id

domain_name

String

域名

enterprise_project_id

String

企业项目id

dispatch_status

String

  • 调度状态:

  • 调度异常:dispatch_abnormal

  • 未调度:un_dispatch

  • 调度中:dispatching

  • 已调度:dispatched

  • 删除中:dispatch_deleting

web_name

String

网站名称

description

String

描述

policy_id

String

策略id

protect_status

String

  • 防护状态:

  • 防护中:on

  • 未防护:off

create_time

Long

创建域名的时间

update_time

Long

更新域名的时间

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

标准化错误码:服务名.八位数字编码

error_msg

String

清晰的错误信息

encoded_authorization_message

String

对接IAM5.0的服务,拒绝访问时需要返回IAM的相关响应

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

标准化错误码:服务名.八位数字编码

error_msg

String

清晰的错误信息

encoded_authorization_message

String

对接IAM5.0的服务,拒绝访问时需要返回IAM的相关响应

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

标准化错误码:服务名.八位数字编码

error_msg

String

清晰的错误信息

encoded_authorization_message

String

对接IAM5.0的服务,拒绝访问时需要返回IAM的相关响应

请求示例

响应示例

状态码

状态码

描述

200

请求成功

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码