查看域名组详情
功能介绍
查看域名组详情
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/domain-set/{domain_set_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，可以从调API处获取，也可以从控制台获取。可通过项目ID获取方式获取 |
|
domain_set_id |
是 |
String |
域名组ID，可通过查询域名组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获取 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
fw_instance_id |
是 |
String |
防火墙ID，可通过防火墙ID获取方式获取 |
|
enterprise_project_id |
否 |
String |
企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token，可通过如何获取用户Token获取 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
DomainSetVo object |
域名组详细信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
set_id |
String |
域名组id |
|
name |
String |
域名组名称 |
|
description |
String |
域名组描述 |
|
ref_count |
Integer |
域名组被规则引用次数 |
|
domain_set_type |
Integer |
域名组类型，0表示应用域名组，1表示网络域名组 |
|
config_status |
Integer |
配置状态，-1表示未配置态，0表示配置失败，1表示配置成功，2表示配置中，3表示正常，4表示配置异常 |
|
rules |
Array of UseRuleVO objects |
使用规则id列表 |
请求示例
查询域名组id为7891eb51-009a-4e4e-ab15-e4290d9360b2的详细信息，防火墙id为fced7179-64a4-4438-bc6d-b510a2da2f64，项目id为408972e72dcd4c1a9b033e955802a36b
https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/domain-set/7891eb51-009a-4e4e-ab15-e4290d9360b2?fw_instance_id=fced7179-64a4-4438-bc6d-b510a2da2f64
响应示例
状态码： 200
域名组详细信息响应值
{
"data" : {
"config_status" : 3,
"domain_set_type" : 0,
"name" : "应用组2",
"set_id" : "7891eb51-009a-4e4e-ab15-e4290d9360b2"
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
域名组详细信息响应值 |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
错误码
请参见错误码。
