Skip to content

Commit

Permalink
docs: 安全组管理相关接口文档-资源下 --story=121690059
Browse files Browse the repository at this point in the history
  • Loading branch information
@yangfan-njupt
yangfan-njupt committed Jan 16, 2025
1 parent 4875605 commit 610b578
Show file tree
Hide file tree
Showing 9 changed files with 436 additions and 155 deletions.
45 changes: 0 additions & 45 deletions ...pi-docs/web-server/docs/resource/security_group/assign_security_group_to_biz.md
View file

This file was deleted.

51 changes: 51 additions & 0 deletions ...s/web-server/docs/resource/security_group/batch_assign_security_group_to_biz.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
### 描述

- 该接口提供版本：v9.9.9+。
- 该接口所需权限：资源-资源分配。
- 该接口功能描述：批量分配安全组到业务。

### URL

POST /api/v1/cloud/security_groups/assign/bizs/batch

### 输入参数

| 参数名称 | 参数类型 | 必选 | 描述 |
|-----------------|--------------|----|----------|
| security_groups | object array | 是 | 分配的安全组列表 |

#### security_groups[n]

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

### 调用示例

```json
{
"security_groups": [
{
"security_group_ids": "00000001",
"bk_biz_id": 100
}
]
}
```

### 响应示例

```json
{
"code": 0,
"message": "ok"
}
```

### 响应参数说明

| 参数名称 | 参数类型 | 描述 |
|---------|--------|------|
| code | int32 | 状态码 |
| message | string | 请求信息 |
55 changes: 55 additions & 0 deletions ...ver/docs/resource/security_group/batch_update_security_group_management_attr.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
### 描述

- 该接口提供版本：v9.9.9+。
- 该接口所需权限：资源-IaaS资源操作。
- 该接口功能描述：批量更新安全组管理属性，仅当所有管理属性均不存在时才允许编辑，所有管理属性都要提供。

### URL

PATCH /api/v1/cloud/security_groups/management_attrs/batch

### 输入参数

| 参数名称 | 参数类型 | 必选 | 描述 |
|-----------------|--------------|----|----------|
| security_groups | object array | 是 | 更新的安全组列表 |

#### security_groups[n]

| 参数名称 | 参数类型 | 必选 | 描述 |
|-------------|--------|----|-------|
| id | string | 是 | 安全组ID |
| manager | string | 是 | 负责人 |
| bak_manager | string | 是 | 备份负责人 |
| mgmt_biz_id | int | 是 | 管理业务 |

### 调用示例

```json
{
"security_groups": [
{
"id": "00000001",
"manager": "lihua",
"bak_manager": "hanmeimei",
"mgmt_biz_id": 123
}
]
}
```

### 响应示例

```json
{
"code": 0,
"message": "ok"
}
```

### 响应参数说明

| 参数名称 | 参数类型 | 描述 |
|---------|--------|------|
| code | int32 | 状态码 |
| message | string | 请求信息 |
61 changes: 44 additions & 17 deletions docs/api-docs/web-server/docs/resource/security_group/create_security_group.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,29 @@ POST /api/v1/cloud/security_groups/create

### 输入参数

| 参数名称 | 参数类型 | 必选 | 描述 |
|-----------------|--------|------|----------------------------------|
| vendor | string | 是 | 供应商（枚举值：tcloud、aws、azure、huawei） |
| account_id | string | 是 | 账号ID |
| region | string | 是 | 地域 |
| name | string | 是 | 安全组名称 |
| memo | string | 否 | 备注 |
| extension | object | 否 | 混合云资源差异字段（aws、azure必填） |
| 参数名称 | 参数类型 | 必选 | 描述 |
|---------------|-----------|----|----------------------------------|
| 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 @@ -41,6 +44,12 @@ POST /api/v1/cloud/security_groups/create
"account_id": "00000003",
"region": "ap-guangzhou",
"name": "sg-create-test",
"manager": "lihua",
"bak_manager": "hanmeimei",
"usage_biz_ids": [
123,
234
],
"memo": "sg test"
}
```
Expand All @@ -53,6 +62,12 @@ POST /api/v1/cloud/security_groups/create
"account_id": "00000012",
"region": "us-west-2",
"name": "sg-create-test",
"manager": "lihua",
"bak_manager": "hanmeimei",
"usage_biz_ids": [
123,
234
],
"memo": "sg test",
"extension": {
"cloud_vpc_id": "vpc-xxxxx"
Expand All @@ -68,6 +83,12 @@ POST /api/v1/cloud/security_groups/create
"account_id": "0000001z",
"region": "ap-southeast-1",
"name": "sg-create-test",
"manager": "lihua",
"bak_manager": "hanmeimei",
"usage_biz_ids": [
123,
234
],
"memo": "sg test"
}
```
Expand All @@ -80,6 +101,12 @@ POST /api/v1/cloud/security_groups/create
"account_id": "00000024",
"region": "westus",
"name": "sg-create-test",
"manager": "lihua",
"bak_manager": "hanmeimei",
"usage_biz_ids": [
123,
234
],
"memo": "sg test",
"extension": {
"resource_group_name": "bk"
Expand Down Expand Up @@ -109,6 +136,6 @@ POST /api/v1/cloud/security_groups/create

#### data

| 参数名称 | 参数类型 | 描述 |
|-----|----------|-------|
| id | string | 安全组ID |
| 参数名称 | 参数类型 | 描述 |
|------|--------|-------|
| id | string | 安全组ID |
72 changes: 42 additions & 30 deletions docs/api-docs/web-server/docs/resource/security_group/get_security_group.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### 描述

- 该接口提供版本：v1.0.0+。
- 该接口所需权限：资源查看。
- 该接口所需权限：资源-资源查看。
- 该接口功能描述：查询安全组详情。

### URL
Expand All @@ -10,9 +10,9 @@ GET /api/v1/cloud/security_groups/{id}

### 输入参数

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

### 调用示例

Expand All @@ -35,6 +35,14 @@ GET /api/v1/cloud/security_groups/{id}
"cloud_id": "sg-xxxxx",
"region": "ap-guangzhou",
"name": "sg-demo",
"manager": "lihua",
"bak_manager": "hanmeimei",
"usage_biz_ids": [
123,
234
],
"mgmt_biz_id": 213,
"mgmt_type": "biz",
"memo": "安全组测试demo",
"account_id": "00000001",
"bk_biz_id": -1,
Expand Down Expand Up @@ -68,28 +76,32 @@ GET /api/v1/cloud/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 |
| region | string | 地域 |
| name | string | 安全组名称 |
| manager | string | 负责人 |
| bak_manager | string | 备份负责人 |
| usage_biz_ids | int array | 使用业务ID列表，-1代表全部业务可使用 |
| mgmt_biz_id | int | 管理业务ID |
| mgmt_type | string | 管理类型，枚举值：biz（业务管理）、platform（平台管理）。该字段可能为空，表示未确定管理类型 |
| 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 |

#### extension[tcloud]

Expand All @@ -99,10 +111,10 @@ GET /api/v1/cloud/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
Loading

0 comments on commit 610b578

Please sign in to comment.