获取域名组下域名列表
功能介绍
获取域名组下域名列表
URI
GET /v1/{project_id}/domain-set/domains/{domain_set_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式 |
| domain_set_id | 是 | String | 域名组id，可通过查询域名组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enterprise_project_id | 否 | String | 企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 |
| fw_instance_id | 是 | String | 防火墙id，可通过防火墙ID获取方式获取 |
| limit | 是 | Integer | 每页显示个数，范围为1-1024 |
| offset | 是 | Integer | 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
| domain_name | 否 | String | 域名名称，如www.test.com |
| object_Id | 否 | String | 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。可通过如何获取用户Token获取。 |
| Content-Type | 是 | String | 内容类型，只有application/json的值是适用的 |
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | ListDomainResponseData object | 查询域名列表返回值数据 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| limit | Integer | 每页显示个数，范围为1-1024 |
| offset | Integer | 偏移量：指定返回记录的开始位置，必须为数字，取值范围为大于或等于0，默认0 |
| project_id | String | 项目ID |
| records | Array of DomainInfo objects | 域名信息列表 |
| set_id | String | 域名组id |
| total | Integer | 域名总数 |
请求示例
查询项目id为14181c1245cf4fd786824efe1e2b9388下的域名列表，域名组id为78719348-6d79-477e-acec-676a29842ab2，防火墙id为546af3f8-88e9-47f2-a205-2346d7090925。
https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/domain-set/domains/78719348-6d79-477e-acec-676a29842ab2?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default&limit=200&offset=0 响应示例
状态码：200
查询域名列表返回值
{
"data" : {
"limit" : 200,
"offset" : 0,
"project_id" : "14181c1245cf4fd786824efe1e2b9388",
"records" : [ {
"description" : "",
"domain_address_id" : "6718279e-9761-4623-a48d-b16957b19e1b",
"domain_name" : "www.test.com"
} ],
"set_id" : "78719348-6d79-477e-acec-676a29842ab2",
"total" : 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询域名列表返回值 |
错误码
请参见错误码。
