Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 安全组管理 业务下接口文档 #1249

Open
wants to merge 2 commits into
base: feat-sg-mgmt
Choose a base branch
from
Open

docs: 安全组管理 业务下接口文档 #1249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1c0933
docs: 安全组管理范围 业务下接口文档
chenjr15 Jan 16, 2025
209ad48
fix: review issue
chenjr15 Jan 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/api-docs/web-server/docs/biz/load-balancer/get_load_balancer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,12 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/load_balancers/{id}
| bk_biz_id | int64 | 业务ID |
| account_id | string | 账号ID |
| region | string | 地域 |
| main_zones | string | 主可用区 |
| zones | string | 主可用区 |
| backup_zones | string | 备可用区 |
| cloud_vpc_id | string | 云vpcID |
| vpc_id | string | vpcID |
| network_type | string | 网络类型 |
| lb_type | string | 负载均衡类型 |
| ip_version | string | 负载均衡网络版本 |
| memo | string | 备注 |
| status | string | 状态 |
| domain | string | 域名 |
Expand Down
10 changes: 6 additions & 4 deletions docs/api-docs/web-server/docs/biz/load-balancer/list_biz_load_balancer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/load_balancers/list
"bk_biz_id": -1,
"account_id": "0000001",
"region": "ap-hk",
"main_zones": [
"zones": [
"ap-hk-1"
],
"backup_zones": [
Expand All @@ -196,7 +196,8 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/load_balancers/list
],
"cloud_vpc_id": "vpc-123",
"vpc_id": "00000002",
"network_type": "ipv4",
"ip_version": "ipv4",
"lb_type": "OPEN",
"domain": "",
"memo": "lb test",
"status": "init",
Expand Down Expand Up @@ -259,11 +260,12 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/load_balancers/list
| bk_biz_id | int64 | 业务ID |
| account_id | string | 账号ID |
| region | string | 地域 |
| main_zones | string | 主可用区 |
| zones | string | 主可用区 |
| backup_zones | string | 备可用区 |
| cloud_vpc_id | string | 云vpcID |
| vpc_id | string | vpcID |
| network_type | string | 网络类型 |
| lb_type | string | 负载均衡类型 |
| ip_version | string | 负载均衡网络版本 |
| memo | string | 备注 |
| status | string | 状态 |
| domain | string | 域名 |
Expand Down
63 changes: 45 additions & 18 deletions docs/api-docs/web-server/docs/biz/security-group/create_security_group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,30 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/create

### 输入参数

| 参数名称 | 参数类型 | 必选 | 描述 |
|-----------------|--------|------|----------------------------------|
| bk_biz_id | int64 | 是 | 业务ID |
| vendor | string | 是 | 供应商（枚举值：tcloud、aws、azure、huawei） |
| account_id | string | 是 | 账号ID |
| region | string | 是 | 地域 |
| name | string | 是 | 安全组名称 |
| memo | string | 否 | 备注 |
| extension | object | 否 | 混合云资源差异字段（aws、azure必填） |
| 参数名称 | 参数类型 | 必选 | 描述 |
|---------------|-----------|----|----------------------------------|
| bk_biz_id | int64 | 是 | 业务ID |
| vendor | string | 是 | 供应商（枚举值：tcloud、aws、azure、huawei） |
| account_id | string | 是 | 账号ID |
| region | string | 是 | 地域 |
| name | string | 是 | 安全组名称 |
| manager | string | 是 | 负责人 |
| bak_manager | string | 是 | 备份负责人 |
| usage_biz_ids | int array | 否 | 不传默认为当前业务，不能传入-1, 传入的业务可以不包含当前业务 |
| memo | string | 否 | 备注 |
| extension | object | 否 | 混合云资源差异字段（aws、azure必填） |

#### extension[aws]

| 参数名称 | 参数类型 | 必选 | 描述 |
|--------------|--------|-----|--|
| cloud_vpc_id | string | 是 | 云VpcID |
| 参数名称 | 参数类型 | 必选 | 描述 |
|--------------|--------|----|--------|
| cloud_vpc_id | string | 是 | 云VpcID |

#### extension[azure]

| 参数名称 | 参数类型 | 必选 | 描述 |
|--|--------|-----|----------------------------------|
| resource_group_name | string | 是 | 资源组名称 |
| 参数名称 | 参数类型 | 必选 | 描述 |
|---------------------|--------|----|-------|
| resource_group_name | string | 是 | 资源组名称 |

### 调用示例

Expand All @@ -42,6 +45,12 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/create
"account_id": "00000003",
"region": "ap-guangzhou",
"name": "sg-create-test",
"manager": "u1",
"bak_manager": "u2",
"usage_biz_ids": [
123,
234
],
"memo": "sg test"
}
```
Expand All @@ -55,6 +64,12 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/create
"region": "us-west-2",
"name": "sg-create-test",
"memo": "sg test",
"manager": "u1",
"bak_manager": "u2",
"usage_biz_ids": [
123,
234
],
"extension": {
"cloud_vpc_id": "vpc-xxxxx"
}
Expand All @@ -69,6 +84,12 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/create
"account_id": "0000001z",
"region": "ap-southeast-1",
"name": "sg-create-test",
"manager": "u1",
"bak_manager": "u2",
"usage_biz_ids": [
123,
234
],
"memo": "sg test"
}
```
Expand All @@ -82,6 +103,12 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/create
"region": "westus",
"name": "sg-create-test",
"memo": "sg test",
"manager": "u1",
"bak_manager": "u2",
"usage_biz_ids": [
123,
234
],
"extension": {
"resource_group_name": "bk"
}
Expand Down Expand Up @@ -110,6 +137,6 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/create

#### data

| 参数名称 | 参数类型 | 描述 |
|-----|----------|-------|
| id | string | 安全组ID |
| 参数名称 | 参数类型 | 描述 |
|------|--------|-------|
| id | string | 安全组ID |
73 changes: 43 additions & 30 deletions docs/api-docs/web-server/docs/biz/security-group/get_security_group.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ GET /api/v1/cloud/bizs/{bk_biz_id}/security_groups/{id}

### 输入参数

| 参数名称 | 参数类型 | 必选 | 描述 |
|------------|---------|----|-------|
| bk_biz_id | int64 | 是 | 业务ID |
| id | string | 是 | 安全组ID |
| 参数名称 | 参数类型 | 必选 | 描述 |
|-----------|--------|----|-------|
| bk_biz_id | int64 | 是 | 业务ID |
| id | string | 是 | 安全组ID |

### 调用示例

Expand All @@ -39,6 +39,14 @@ GET /api/v1/cloud/bizs/{bk_biz_id}/security_groups/{id}
"memo": "安全组测试demo",
"account_id": "00000001",
"bk_biz_id": -1,
"manager": "u1",
"bak_manager": "",
"usage_biz_ids": [
123,
234
],
"mgmt_biz_id": 123,
"mgmt_type": "biz",
"creator": "jim",
"reviser": "jim",
"created_at": "2022-12-26T15:49:40Z",
Expand Down Expand Up @@ -69,28 +77,33 @@ GET /api/v1/cloud/bizs/{bk_biz_id}/security_groups/{id}

#### data

| 参数名称 | 参数类型 | 描述 |
|-------------------------|-------------------|------------------------------------|
| id | string | 安全组ID |
| vendor | string | 云厂商 |
| cloud_id | string | 安全组云ID |
| bk_biz_id | int64 | 业务ID |
| region | string | 地域 |
| name | string | 安全组名称 |
| memo | string | 备注 |
| account_id | string | 账号ID |
| bk_biz_id | int64 | 业务ID, -1代表未分配业务。 |
| cvm_count | uint64 | 关联虚拟机数量。（tcloud、aws、huawei专属） |
| network_interface_count | uint64 | 关联网络接口数量。（azure专属） |
| subnet_count | uint64 | 关联子网数量。（azure专属） |
| extension | object[vendor] | 混合云差异字段 |
| creator | string | 创建者 |
| reviser | string | 最后一次修改的修改者 |
| created_at | string | 创建时间，标准格式：2006-01-02T15:04:05Z |
| updated_at | string | 最后一次修改时间，标准格式：2006-01-02T15:04:05Z |
| tags | map[string]string | 标签字典 |
| cloud_created_time | string | 安全组云上创建时间，标准格式：2006-01-02 15:04:05 |
| cloud_update_time | string | 安全组云上更新时间，标准格式：2006-01-02 15:04:05 |
| 参数名称 | 参数类型 | 描述 |
|-------------------------|-------------------|-----------------------------------------------------|
| id | string | 安全组ID |
| vendor | string | 云厂商 |
| cloud_id | string | 安全组云ID |
| bk_biz_id | int64 | 业务ID |
| region | string | 地域 |
| name | string | 安全组名称 |
| memo | string | 备注 |
| account_id | string | 账号ID |
| mgmt_type | string | 管理类型，枚举值：biz（业务管理）、platform（平台管理）。该字段可能为空，表示未确定管理类型 |
| mgmt_biz_id | int64 | 管理业务ID |
| manager | string | 负责人 |
| bak_manager | string | 备份负责人 |
| usage_biz_ids | int64 array | 使用业务ID列表，-1代表全部业务可使用 |
| bk_biz_id | int64 | 业务ID, -1代表未分配业务。 |
| cvm_count | uint64 | 关联虚拟机数量。（tcloud、aws、huawei专属） |
| network_interface_count | uint64 | 关联网络接口数量。（azure专属） |
| subnet_count | uint64 | 关联子网数量。（azure专属） |
| extension | object[vendor] | 混合云差异字段 |
| creator | string | 创建者 |
| reviser | string | 最后一次修改的修改者 |
| created_at | string | 创建时间，标准格式：2006-01-02T15:04:05Z |
| updated_at | string | 最后一次修改时间，标准格式：2006-01-02T15:04:05Z |
| tags | map[string]string | 标签字典 |
| cloud_created_time | string | 安全组云上创建时间，标准格式：2006-01-02 15:04:05 |
| cloud_update_time | string | 安全组云上更新时间，标准格式：2006-01-02 15:04:05 |

#### extension[tcloud]

Expand All @@ -100,10 +113,10 @@ GET /api/v1/cloud/bizs/{bk_biz_id}/security_groups/{id}

#### extension[aws]

| 参数名称 | 参数类型 | 描述 |
|----------------|--------|-------------------|
| vpc_id | string | vpc主键ID。 |
| cloud_vpc_id | string | vpc云主键ID。 |
| 参数名称 | 参数类型 | 描述 |
|----------------|--------|--------------------|
| vpc_id | string | vpc主键ID。 |
| cloud_vpc_id | string | vpc云主键ID。 |
| cloud_owner_id | string | 拥有该安全组的Amazon账号ID。 |

#### extension[azure]
Expand Down
72 changes: 72 additions & 0 deletions ...api-docs/web-server/docs/biz/security-group/list_biz_security_group_business.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
### 描述

- 该接口提供版本：v9.9.9+。
- 该接口所需权限：业务访问。
- 该接口功能描述：查询安全组关联资源所属的业务列表，目前仅支持查询关联的CVM和CLB资源。

### URL

POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/bizs/list

### 输入参数

| 参数名称 | 参数类型 | 必选 | 描述 |
|-----------|--------|----|---------|
| bk_biz_id | int64 | 是 | 安全组业务ID |
| sg_id | string | 是 | 安全组ID |

### 调用示例

```json
```

### 响应示例

```json
{
"code": 0,
"message": "ok",
"data": {
"cvm": [
{
"bk_biz_id": 123,
"res_count": 0
},
{
"bk_biz_id": 234,
"res_count": 10
}
],
"load_balancer": [
{
"bk_biz_id": 123,
"res_count": 600
}
]
}
}
```

### 响应参数说明

| 参数名称 | 参数类型 | 描述 |
|---------|--------|------|
| code | int32 | 状态码 |
| message | string | 请求信息 |
| data | object | 响应数据 |

#### data

##### 说明：返回的业务列表中，一定包含管理业务，且一定排在第一个（即使为空）

| 参数名称 | 参数类型 | 描述 |
|---------------|--------------|----------------------------|
| cvm | object array | 安全组关联的CVM所属的业务列表 |
| load_balancer | object array | 安全组关联的load balancer所属的业务列表 |

##### cvm[n] && load_balancer[n]

| 参数名称 | 参数类型 | 描述 |
|-----------|------|-----------------|
| bk_biz_id | int | 资源所属业务ID |
| res_count | int | 该业务下的CVM或LB资源总数 |
Loading