文档首页
API docs by Redocly

爱快 OpenAPI - 对象分组 (1.0.0)

Download OpenAPI specification:

License: 内部测试文档

来源于 ikuai-doc/openapi_specs/object_group/。

为避免 Redoc 单页一次性加载全部 API 导致浏览器 heap 过高，部署版按分类拆分。

域名对象管理API

来源文件: object_group/network-object-domain.json

获取域名对象列表

获取所有域名对象策略列表。 支持分页功能。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1

页码（从1开始）

limit
integer [ 1 .. 1000 ]
Default: 20

每页记录数

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

创建域名对象

创建新的域名对象策略。 支持多个域名配置。

Authorizations:
bearerAuth
Request Body schema: application/json
required

域名对象配置数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects

域名列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "domain00",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success",
  • "rowid": 1
}

获取指定域名对象

根据ID获取单个域名对象的详细信息。 需要提供有效的对象ID。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

域名对象ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

更新域名对象

修改指定域名对象的配置信息。 支持部分字段更新。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

域名对象ID

Request Body schema: application/json
required

域名对象更新数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects

域名列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "domain00",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

删除域名对象

删除指定的域名对象。 删除后对象将被永久移除，无法恢复。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

域名对象ID

Responses

Response samples

Content type
application/json
{
  • "message": "success"
}

查询域名对象引用关系

查询引用指定域名对象的所有规则列表。 需要提供group_name参数。

Authorizations:
bearerAuth
query Parameters
group_name
required
string
Example: group_name=domain00

对象名称

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

IP对象管理API

来源文件: object_group/network-object-ip.json

获取IP对象列表

获取所有IP对象策略列表。 支持分页功能。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 20
Example: limit=20

每页记录数

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

创建IP对象

创建新的IP对象策略。 支持单个IP、IP范围、IP/掩码格式。

Authorizations:
bearerAuth
Request Body schema: application/json
required

IP对象配置数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects (object_group_network_object_ip_IpObjectValue) [ 1 .. 100 ] items

对象内容列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "ip66",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

获取指定IP对象

根据ID获取单个IP对象的详细信息。 需要提供有效的对象ID。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

IP对象ID

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

更新IP对象

完全更新现有的IP对象配置。 需要提供所有字段。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

IP对象ID

Request Body schema: application/json
required

完整的IP对象配置数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects (object_group_network_object_ip_IpObjectValue) [ 1 .. 100 ] items

对象内容列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "ip66",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

删除IP对象

删除指定的IP对象。 删除后无法恢复，请谨慎操作。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

IP对象ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

查询IP对象引用

获取引用指定IP对象的规则列表。 可以查询哪些ACL规则引用了特定的对象。

Authorizations:
bearerAuth
query Parameters
group_name
required
string non-empty
Example: group_name=ip66

IP对象名称

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

IPv6对象管理API

来源文件: object_group/network-object-ip6.json

获取IPv6对象列表

获取所有IPv6对象策略列表。 支持分页功能。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1

页码（从1开始）

limit
integer [ 1 .. 1000 ]
Default: 20

每页记录数

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

创建IPv6对象

创建新的IPv6对象策略。 支持单个IPv6地址或IPv6地址段。

Authorizations:
bearerAuth
Request Body schema: application/json
required

IPv6对象配置数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects

IPv6地址列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "ipv600",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success",
  • "rowid": 1
}

获取指定IPv6对象

根据ID获取单个IPv6对象的详细信息。 需要提供有效的对象ID。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

IPv6对象ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

更新IPv6对象

修改指定IPv6对象的配置信息。 支持部分字段更新。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

IPv6对象ID

Request Body schema: application/json
required

IPv6对象更新数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects

IPv6地址列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "ipv600",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

删除IPv6对象

删除指定的IPv6对象。 删除后对象将被永久移除，无法恢复。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

IPv6对象ID

Responses

Response samples

Content type
application/json
{
  • "message": "success"
}

查询IPv6对象引用关系

查询引用指定IPv6对象的所有规则列表。 需要提供group_name参数。

Authorizations:
bearerAuth
query Parameters
group_name
required
string
Example: group_name=ipv600

对象名称

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

MAC对象管理API

来源文件: object_group/network-object-mac.json

获取MAC对象列表

获取所有MAC对象策略列表。 支持分页功能。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 20
Example: limit=20

每页记录数

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

创建MAC对象

创建新的MAC对象策略。 支持MAC地址格式：08:9b:4b:00:10:6e。

Authorizations:
bearerAuth
Request Body schema: application/json
required

MAC对象配置数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects (object_group_network_object_mac_MacObjectValue) [ 1 .. 100 ] items

对象内容列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "mac00",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

获取指定MAC对象

根据ID获取单个MAC对象的详细信息。 需要提供有效的对象ID。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

MAC对象ID

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

更新MAC对象

完全更新现有的MAC对象配置。 需要提供所有字段。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

MAC对象ID

Request Body schema: application/json
required

完整的MAC对象配置数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects (object_group_network_object_mac_MacObjectValue) [ 1 .. 100 ] items

对象内容列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "mac00",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

删除MAC对象

删除指定的MAC对象。 删除后无法恢复，请谨慎操作。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

MAC对象ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

查询MAC对象引用

获取引用指定MAC对象的规则列表。 可以查询哪些ACL规则引用了特定的对象。

Authorizations:
bearerAuth
query Parameters
group_name
required
string non-empty
Example: group_name=mac00

MAC对象名称

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

端口对象管理API

来源文件: object_group/network-object-port.json

获取端口对象列表

获取所有端口对象策略列表。 支持分页功能。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1

页码（从1开始）

limit
integer [ 1 .. 1000 ]
Default: 20

每页记录数

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

创建端口对象

创建新的端口对象策略。 支持单个端口或端口范围配置。

Authorizations:
bearerAuth
Request Body schema: application/json
required

端口对象配置数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects

端口列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "port00",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success",
  • "rowid": 1
}

获取指定端口对象

根据ID获取单个端口对象的详细信息。 需要提供有效的对象ID。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

端口对象ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

更新端口对象

修改指定端口对象的配置信息。 支持部分字段更新。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

端口对象ID

Request Body schema: application/json
required

端口对象更新数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects

端口列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "port00",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

删除端口对象

删除指定的端口对象。 删除后对象将被永久移除，无法恢复。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

端口对象ID

Responses

Response samples

Content type
application/json
{
  • "message": "success"
}

查询端口对象引用关系

查询引用指定端口对象的所有规则列表。 需要提供group_name参数。

Authorizations:
bearerAuth
query Parameters
group_name
required
string
Example: group_name=port00

对象名称

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

协议对象管理API

来源文件: object_group/network-object-proto.json

获取协议对象列表

获取所有协议对象策略列表。 支持分页功能。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1

页码（从1开始）

limit
integer [ 1 .. 1000 ]
Default: 20

每页记录数

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

创建协议对象

创建新的协议对象策略。 支持多种协议类型。

Authorizations:
bearerAuth
Request Body schema: application/json
required

协议对象配置数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects

协议列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "proto00",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success",
  • "rowid": 1
}

获取指定协议对象

根据ID获取单个协议对象的详细信息。 需要提供有效的对象ID。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

协议对象ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

更新协议对象

修改指定协议对象的配置信息。 支持部分字段更新。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

协议对象ID

Request Body schema: application/json
required

协议对象更新数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects

协议列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "proto00",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "success"
}

删除协议对象

删除指定的协议对象。 删除后对象将被永久移除，无法恢复。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

协议对象ID

Responses

Response samples

Content type
application/json
{
  • "message": "success"
}

查询协议对象引用关系

查询引用指定协议对象的所有规则列表。 需要提供group_name参数。

Authorizations:
bearerAuth
query Parameters
group_name
required
string
Example: group_name=proto00

对象名称

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success",
  • "results": {
    }
}

时间对象管理API

来源文件: object_group/network-object-time.json

获取时间对象列表

获取所有时间对象策略列表。 支持分页功能。

Authorizations:
bearerAuth
query Parameters
page
integer >= 1
Default: 1
Example: page=1

页码（从1开始）

limit
integer >= 1
Default: 20
Example: limit=20

每页记录数

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

创建时间对象

创建新的时间对象策略。 支持两种时间类型：

  • weekly（按周循环）：需要weekdays、start_time、end_time
  • date（日期时间）：需要start_time、end_time
Authorizations:
bearerAuth
Request Body schema: application/json
required

时间对象配置数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects (object_group_network_object_time_TimeObjectValue) [ 1 .. 100 ] items

对象内容列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "time00",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

获取指定时间对象

根据ID获取单个时间对象的详细信息。 需要提供有效的对象ID。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

时间对象ID

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}

更新时间对象

完全更新现有的时间对象配置。 需要提供所有字段。

注意： 本接口为全量修改，请求时需传入所有字段。无需修改的字段请保持原值或传空值，未传入的字段可能被重置。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

时间对象ID

Request Body schema: application/json
required

完整的时间对象配置数据

group_name
required
string [ 1 .. 15 ] characters ^[\\u4e00-\\u9fa5a-zA-Z0-9]+$

对象名称（仅支持中文、英文、数字，长度限制1-15字符）

required
Array of objects (object_group_network_object_time_TimeObjectValue) [ 1 .. 100 ] items

对象内容列表

Responses

Request samples

Content type
application/json
{
  • "group_name": "time00",
  • "group_value": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "code": 0,
  • "message": "Success"
}

删除时间对象

删除指定的时间对象。 删除后无法恢复，请谨慎操作。

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64> >= 1
Example: 1

时间对象ID

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "Success"
}

查询时间对象引用

获取引用指定时间对象的规则列表。 可以查询哪些ACL规则引用了特定的对象。

Authorizations:
bearerAuth
query Parameters
group_name
required
string non-empty
Example: group_name=time00

时间对象名称

Responses

Response samples

Content type
application/json
{
  • "message": "Success",
  • "results": {
    }
}