查询域名组列表
功能介绍
查询域名组列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/domain-sets
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户项目id |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enterprise_project_id | 否 | String | 企业项目id，用户支持企业项目后，由企业项目生成的id。 |
| fw_instance_id | 是 | String | 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 |
| limit | 是 | Integer | 每页显示个数，范围为1-1024 |
| offset | 是 | Integer | 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
| object_id | 是 | String | 互联网边界防护对象id，可通过调用查询防火墙实例接口，type为0的为互联网边界防护对象id。 |
| key_word | 否 | String | 关键字 |
| domain_set_type | 否 | Integer | 域名组类型，0表示应用域名组，1表示网络域名组 |
| config_status | 否 | Integer | 配置状态 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | ListDomainsetsResponseData object | 查询域名组返回值列表data |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| limit | Integer | 每页显示个数，范围为1-1024 |
| offset | Integer | 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
| total | Integer | 总数 |
| records | Array of DomainSetVo objects | 域名组列表 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| set_id | String | 域名组id |
| name | String | 域名组名称 |
| description | String | 描述 |
| ref_count | Integer | 引用次数 |
| domain_set_type | Integer | 域名组类型，0表示应用域名组，1表示网络域名组 |
| config_status | Integer | 配置状态 |
| message | String | 异常信息 |
| rules | Array of UseRuleVO objects | 使用规则id列表 |
请求示例
查询项目id为9d80d070b6d44942af73c9c3d38e0429下的防火墙 id为546af3f8-88e9-47f2-a205-2346d7090925下的域名组列表，防护对象id为ae42418e-f077-41a0-9d3b-5b2f5ad9102b
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/domain-sets?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=50&offset=0&object_id=ae42418e-f077-41a0-9d3b-5b2f5ad9102b 响应示例
状态码： 200
查询域名组返回值
{
"data" : {
"limit" : 50,
"offset" : 0,
"records" : [ {
"config_status" : 3,
"description" : "",
"domain_set_type" : 0,
"name" : "ccdd",
"ref_count" : 0,
"set_id" : "e43db369-a863-45ed-8850-58d6b571b1ab"
} ],
"total" : 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询域名组返回值 |
错误码
请参见错误码。
