From a1c0933a31be4e07d09bb0471157f665488ffbb8 Mon Sep 17 00:00:00 2001 From: chenjr15 Date: Thu, 16 Jan 2025 20:39:31 +0800 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20=E5=AE=89=E5=85=A8=E7=BB=84?= =?UTF-8?q?=E7=AE=A1=E7=90=86=E8=8C=83=E5=9B=B4=20=E4=B8=9A=E5=8A=A1?= =?UTF-8?q?=E4=B8=8B=E6=8E=A5=E5=8F=A3=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../security-group/create_security_group.md | 63 ++-- .../biz/security-group/get_security_group.md | 73 +++-- .../biz/security-group/list_security_group.md | 134 +++++---- .../list_security_group_rel_cvm_by_biz.md | 211 +++++++++++++ ...security_group_rel_load_balancer_by_biz.md | 280 ++++++++++++++++++ .../query_security_group_rel_res_count.md | 63 ++++ .../update_security_group_mgmt_attr.md | 46 +++ 7 files changed, 760 insertions(+), 110 deletions(-) create mode 100644 docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_cvm_by_biz.md create mode 100644 docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_load_balancer_by_biz.md create mode 100644 docs/api-docs/web-server/docs/biz/security-group/query_security_group_rel_res_count.md create mode 100644 docs/api-docs/web-server/docs/biz/security-group/update_security_group_mgmt_attr.md diff --git a/docs/api-docs/web-server/docs/biz/security-group/create_security_group.md b/docs/api-docs/web-server/docs/biz/security-group/create_security_group.md index cce0907f75..bc8f59ff36 100644 --- a/docs/api-docs/web-server/docs/biz/security-group/create_security_group.md +++ b/docs/api-docs/web-server/docs/biz/security-group/create_security_group.md @@ -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 | 是 | 资源组名称 | ### 调用示例 @@ -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" } ``` @@ -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" } @@ -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" } ``` @@ -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" } @@ -110,6 +137,6 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/create #### data -| 参数名称 | 参数类型 | 描述 | -|-----|----------|-------| -| id | string | 安全组ID | +| 参数名称 | 参数类型 | 描述 | +|------|--------|-------| +| id | string | 安全组ID | diff --git a/docs/api-docs/web-server/docs/biz/security-group/get_security_group.md b/docs/api-docs/web-server/docs/biz/security-group/get_security_group.md index 7ddeeda9b5..5f54c68b26 100644 --- a/docs/api-docs/web-server/docs/biz/security-group/get_security_group.md +++ b/docs/api-docs/web-server/docs/biz/security-group/get_security_group.md @@ -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 | ### 调用示例 @@ -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", @@ -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] @@ -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] diff --git a/docs/api-docs/web-server/docs/biz/security-group/list_security_group.md b/docs/api-docs/web-server/docs/biz/security-group/list_security_group.md index 5b12ce059f..3bb8497cb3 100644 --- a/docs/api-docs/web-server/docs/biz/security-group/list_security_group.md +++ b/docs/api-docs/web-server/docs/biz/security-group/list_security_group.md @@ -10,43 +10,43 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/list ### 输入参数 -| 参数名称 | 参数类型 | 必选 | 描述 | -|------------|--------|-----|--------| -| bk_biz_id | int64 | 是 | 业务ID | -| filter | object | 是 | 查询过滤条件 | -| page | object | 是 | 分页设置 | +| 参数名称 | 参数类型 | 必选 | 描述 | +|-----------|--------|----|--------| +| bk_biz_id | int64 | 是 | 业务ID | +| filter | object | 是 | 查询过滤条件 | +| page | object | 是 | 分页设置 | #### filter -| 参数名称 | 参数类型 | 必选 | 描述 | -|-------|-------------|-----|-----------------------------------------------------------------| -| op | enum string | 是 | 操作符（枚举值：and、or）。如果是and，则表示多个rule之间是且的关系；如果是or，则表示多个rule之间是或的关系。 | -| rules | array | 是 | 过滤规则，最多设置5个rules。如果rules为空数组，op（操作符）将没有作用，代表查询全部数据。 | +| 参数名称 | 参数类型 | 必选 | 描述 | +|-------|-------------|----|-----------------------------------------------------------------| +| op | enum string | 是 | 操作符（枚举值：and、or）。如果是and，则表示多个rule之间是且的关系；如果是or，则表示多个rule之间是或的关系。 | +| rules | array | 是 | 过滤规则，最多设置5个rules。如果rules为空数组，op（操作符）将没有作用，代表查询全部数据。 | #### rules[n] （详情请看 rules 表达式说明） -| 参数名称 | 参数类型 | 必选 | 描述 | -|-------|-------------|-----|---------------------------------------------| -| field | string | 是 | 查询条件Field名称，具体可使用的用于查询的字段及其说明请看下面 - 查询参数介绍 | -| op | enum string | 是 | 操作符（枚举值：eq、neq、gt、gte、le、lte、in、nin、cs、cis） | -| value | 可变类型 | 是 | 查询条件Value值 | +| 参数名称 | 参数类型 | 必选 | 描述 | +|-------|-------------|----|---------------------------------------------| +| field | string | 是 | 查询条件Field名称，具体可使用的用于查询的字段及其说明请看下面 - 查询参数介绍 | +| op | enum string | 是 | 操作符（枚举值：eq、neq、gt、gte、le、lte、in、nin、cs、cis） | +| value | 可变类型 | 是 | 查询条件Value值 | ##### rules 表达式说明： ##### 1. 操作符 -| 操作符 | 描述 | 操作符的value支持的数据类型 | -|-----|-------------------------------------------|----------------------------------------------| -| eq | 等于。不能为空字符串 | boolean, numeric, string | -| neq | 不等。不能为空字符串 | boolean, numeric, string | +| 操作符 | 描述 | 操作符的value支持的数据类型 | +|-----|-------------------------------------------|-----------------------------------------------| +| eq | 等于。不能为空字符串 | boolean, numeric, string | +| neq | 不等。不能为空字符串 | boolean, numeric, string | | gt | 大于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | | gte | 大于等于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | | lt | 小于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | | lte | 小于等于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | -| in | 在给定的数组范围中。value数组中的元素最多设置100个，数组中至少有一个元素 | boolean, numeric, string | -| nin | 不在给定的数组范围中。value数组中的元素最多设置100个，数组中至少有一个元素 | boolean, numeric, string | -| cs | 模糊查询，区分大小写 | string | -| cis | 模糊查询，不区分大小写 | string | +| in | 在给定的数组范围中。value数组中的元素最多设置100个，数组中至少有一个元素 | boolean, numeric, string | +| nin | 不在给定的数组范围中。value数组中的元素最多设置100个，数组中至少有一个元素 | boolean, numeric, string | +| cs | 模糊查询，区分大小写 | string | +| cis | 模糊查询，不区分大小写 | string | ##### 2. 协议示例 @@ -85,32 +85,37 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/list #### page -| 参数名称 | 参数类型 | 必选 | 描述 | -|-------|--------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------| -| count | bool | 是 | 是否返回总记录条数。 如果为true，查询结果返回总记录条数 count，但查询结果详情数据 details 为空数组，此时 start 和 limit 参数将无效，且必需设置为0。如果为false，则根据 start 和 limit 参数，返回查询结果详情数据，但总记录条数 count 为0 | -| start | uint32 | 否 | 记录开始位置，start 起始值为0 | -| limit | uint32 | 否 | 每页限制条数，最大500，不能为0 | -| sort | string | 否 | 排序字段，返回数据将按该字段进行排序 | -| order | string | 否 | 排序顺序（枚举值：ASC、DESC） | +| 参数名称 | 参数类型 | 必选 | 描述 | +|-------|--------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| count | bool | 是 | 是否返回总记录条数。 如果为true，查询结果返回总记录条数 count，但查询结果详情数据 details 为空数组，此时 start 和 limit 参数将无效，且必需设置为0。如果为false，则根据 start 和 limit 参数，返回查询结果详情数据，但总记录条数 count 为0 | +| start | uint32 | 否 | 记录开始位置，start 起始值为0 | +| limit | uint32 | 否 | 每页限制条数，最大500，不能为0 | +| sort | string | 否 | 排序字段，返回数据将按该字段进行排序 | +| order | string | 否 | 排序顺序（枚举值：ASC、DESC） | #### 查询参数介绍： -| 参数名称 | 参数类型 | 描述 | -|--------------------|--------|------------------------------------| -| id | string | 安全组ID | -| vendor | string | 云厂商 | -| cloud_id | string | 安全组云ID | -| bk_biz_id | int64 | 业务ID, -1代表未分配业务 | -| region | string | 地域 | -| name | string | 安全组名称 | -| memo | string | 备注 | -| account_id | string | 账号ID | -| creator | string | 创建者 | -| reviser | string | 最后一次修改的修改者 | -| created_at | string | 创建时间，标准格式：2006-01-02T15:04:05Z | -| updated_at | string | 最后一次修改时间，标准格式：2006-01-02T15:04:05Z | -| 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, -1代表未分配业务 | +| 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_id | int64 | 使用业务ID列表，-1代表全部业务可使用 | +| creator | string | 创建者 | +| reviser | string | 最后一次修改的修改者 | +| created_at | string | 创建时间，标准格式：2006-01-02T15:04:05Z | +| updated_at | string | 最后一次修改时间，标准格式：2006-01-02T15:04:05Z | +| cloud_created_time | string | 安全组云上创建时间，标准格式：2006-01-02 15:04:05 | +| cloud_update_time | string | 安全组云上更新时间，标准格式：2006-01-02 15:04:05 | 接口调用者可以根据以上参数自行根据查询场景设置查询规则。 @@ -236,21 +241,26 @@ POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/list #### data.details[n] -| 参数名称 | 参数类型 | 描述 | -|--------------------|-------------------|------------------------------------| -| id | string | 安全组ID | -| vendor | string | 云厂商 | -| cloud_id | string | 安全组云ID | -| bk_biz_id | int64 | 业务ID, -1代表未分配业务 | -| region | string | 地域 | -| name | string | 安全组名称 | -| memo | string | 备注 | -| account_id | string | 账号ID | -| 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, -1代表未分配业务 | +| 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代表全部业务可使用 | +| 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 | diff --git a/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_cvm_by_biz.md b/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_cvm_by_biz.md new file mode 100644 index 0000000000..b9da38f42f --- /dev/null +++ b/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_cvm_by_biz.md @@ -0,0 +1,211 @@ +### 描述 + +- 该接口提供版本：v9.9.9+。 +- 该接口所需权限：业务访问。 +- 该接口功能描述：查询安全组关联的cvm列表。 + +### URL + +POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{res_biz_id}/cvms/list + +### 输入参数 + +| 参数名称 | 参数类型 | 必选 | 描述 | +|------------|----------|----|--------------------------------------------| +| bk_biz_id | int64 | 是 | 安全组业务ID | +| sg_id | string | 是 | 安全组ID | +| res_biz_id | int64 | 是 | 关联资源业务ID | +| page | object | 是 | 分页设置 | +| filter | object | 是 | 查询过滤条件 | +| fields | []string | 否 | 查询条件Field名称，具体可使用的用于查询的字段及其说明请看下面 - 查询参数介绍 | + +#### filter + +| 参数名称 | 参数类型 | 必选 | 描述 | +|-------|-------------|----|-----------------------------------------------------------------| +| op | enum string | 是 | 操作符（枚举值：and、or）。如果是and，则表示多个rule之间是且的关系；如果是or，则表示多个rule之间是或的关系。 | +| rules | array | 是 | 过滤规则，最多设置5个rules。如果rules为空数组，op（操作符）将没有作用，代表查询全部数据。 | + +#### rules[n] （详情请看 rules 表达式说明） + +| 参数名称 | 参数类型 | 必选 | 描述 | +|-------|-------------|----|---------------------------------------------| +| field | string | 是 | 查询条件Field名称，具体可使用的用于查询的字段及其说明请看下面 - 查询参数介绍 | +| op | enum string | 是 | 操作符（枚举值：eq、neq、gt、gte、le、lte、in、nin、cs、cis） | +| value | 可变类型 | 是 | 查询条件Value值 | + +##### rules 表达式说明： + +##### 1. 操作符 + +| 操作符 | 描述 | 操作符的value支持的数据类型 | +|-----|-------------------------------------------|-----------------------------------------------| +| eq | 等于。不能为空字符串 | boolean, numeric, string | +| neq | 不等。不能为空字符串 | boolean, numeric, string | +| gt | 大于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | +| gte | 大于等于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | +| lt | 小于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | +| lte | 小于等于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | +| in | 在给定的数组范围中。value数组中的元素最多设置100个，数组中至少有一个元素 | boolean, numeric, string | +| nin | 不在给定的数组范围中。value数组中的元素最多设置100个，数组中至少有一个元素 | boolean, numeric, string | +| cs | 模糊查询，区分大小写 | string | +| cis | 模糊查询，不区分大小写 | string | + +##### 2. 协议示例 + +查询 name 是 "Jim" 且 age 大于18小于30 且 servers 类型是 "api" 或者是 "web" 的数据。 + +```json +{ + "op": "and", + "rules": [ + { + "field": "name", + "op": "eq", + "value": "Jim" + }, + { + "field": "age", + "op": "gt", + "value": 18 + }, + { + "field": "age", + "op": "lt", + "value": 30 + }, + { + "field": "servers", + "op": "in", + "value": [ + "api", + "web" + ] + } + ] +} +``` + +#### page + +| 参数名称 | 参数类型 | 必选 | 描述 | +|-------|--------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| count | bool | 是 | 是否返回总记录条数。 如果为true，查询结果返回总记录条数 count，但查询结果详情数据 details 为空数组，此时 start 和 limit 参数将无效，且必需设置为0。如果为false，则根据 start 和 limit 参数，返回查询结果详情数据，但总记录条数 count 为0 | +| start | uint32 | 否 | 记录开始位置，start 起始值为0 | +| limit | uint32 | 否 | 每页限制条数，最大500，不能为0 | +| sort | string | 否 | 排序字段，返回数据将按该字段进行排序 | +| order | string | 否 | 排序顺序（枚举值：ASC、DESC） | + + +#### 查询参数介绍： + +| 参数名称 | 参数类型 | 描述 | +|---------------------|--------|--------------------------------------| +| cloud_id | string | 云资源ID | +| name | string | 名称 | +| vendor | string | 供应商（枚举值：tcloud、aws、azure、gcp、huawei） | +| bk_biz_id | int64 | 业务ID | +| bk_cloud_id | int64 | 云区域ID | +| account_id | string | 账号ID | +| region | string | 地域 | +| zone | string | 可用区 | +| cloud_image_id | string | 云镜像ID | +| os_name | string | 操作系统名称 | +| memo | string | 备注 | +| status | string | 状态 | +| recycle_status | string | 回收状态 | +| machine_type | string | 设备类型 | +| cloud_created_time | string | Cvm在云上创建时间，标准格式：2006-01-02T15:04:05Z | +| cloud_launched_time | string | Cvm启动时间，标准格式：2006-01-02T15:04:05Z | +| cloud_expired_time | string | Cvm过期时间，标准格式：2006-01-02T15:04:05Z | +| creator | string | 创建者 | +| reviser | string | 修改者 | +| created_at | string | 创建时间，标准格式：2006-01-02T15:04:05Z | +| updated_at | string | 修改时间，标准格式：2006-01-02T15:04:05Z | + +接口调用者可以根据以上参数自行根据查询场景设置查询规则。 + +### 调用示例 + +```json +{ + "page": { + "count": false, + "start": 0, + "limit": 500 + } +} +``` + +### 响应示例 + +```json +{ + "code": 0, + "message": "", + "data": { + "details": [ + { + "id": "00000001", + "cloud_id": "cvm-123", + "name": "cvm-test", + "vendor": "tcloud", + "bk_biz_id": -1, + "account_id": "0000001", + "region": "ap-hk", + "zone": "ap-hk-1", + "cloud_vpc_ids": [ + "vpc-123" + ], + "cloud_subnet_ids": [ + "subnet-123" + ], + "status": "init", + "private_ipv4_addresses": [ + "127.0.0.1" + ], + "private_ipv6_addresses": [], + "public_ipv4_addresses": [ + "127.0.0.2" + ], + "public_ipv6_addresses": [] + } + ] + } +} +``` + +### 响应参数说明 + +| 参数名称 | 参数类型 | 描述 | +|---------|--------|------| +| code | int32 | 状态码 | +| message | string | 请求信息 | +| data | object | 响应数据 | + +#### data + +| 参数名称 | 参数类型 | 描述 | +|---------|--------|----------------| +| count | uint64 | 当前规则能匹配到的总记录条数 | +| details | array | 查询返回的数据 | + +#### data.details[n] + +| 参数名称 | 参数类型 | 描述 | +|------------------------|--------------|--------------------------------------| +| cloud_id | string | 云资源ID | +| name | string | 名称 | +| vendor | string | 供应商（枚举值：tcloud、aws、azure、gcp、huawei） | +| bk_biz_id | int64 | 业务ID | +| region | string | 地域 | +| zone | string | 可用区 | +| cloud_vpc_ids | string array | 云VpcID列表 | +| cloud_subnet_ids | string array | 云子网ID列表 | +| status | string | 状态 | +| private_ipv4_addresses | string array | 内网IPv4地址 | +| private_ipv6_addresses | string array | 内网IPv6地址 | +| public_ipv4_addresses | string array | 公网IPv4地址 | +| public_ipv6_addresses | string array | 公网IPv6地址 | + + diff --git a/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_load_balancer_by_biz.md b/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_load_balancer_by_biz.md new file mode 100644 index 0000000000..51d091d6e4 --- /dev/null +++ b/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_load_balancer_by_biz.md @@ -0,0 +1,280 @@ +### 描述 + +- 该接口提供版本：v9.9.9+。 +- 该接口所需权限：业务访问。 +- 该接口功能描述：查询安全组关联的负载均衡列表。 + +### URL + +POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{res_biz_id}/load_balancers/list + +### 输入参数 + +| 参数名称 | 参数类型 | 必选 | 描述 | +|------------|----------|----|--------------------------------------------| +| bk_biz_id | int64 | 是 | 安全组业务ID | +| sg_id | string | 是 | 安全组ID | +| res_biz_id | int64 | 是 | 关联资源业务ID | +| page | object | 是 | 分页设置 | +| filter | object | 是 | 查询过滤条件 | +| fields | []string | 否 | 查询条件Field名称，具体可使用的用于查询的字段及其说明请看下面 - 查询参数介绍 | + +#### filter + +| 参数名称 | 参数类型 | 必选 | 描述 | +|-------|-------------|----|-----------------------------------------------------------------| +| op | enum string | 是 | 操作符（枚举值：and、or）。如果是and，则表示多个rule之间是且的关系；如果是or，则表示多个rule之间是或的关系。 | +| rules | array | 是 | 过滤规则，最多设置5个rules。如果rules为空数组，op（操作符）将没有作用，代表查询全部数据。 | + +#### rules[n] （详情请看 rules 表达式说明） + +| 参数名称 | 参数类型 | 必选 | 描述 | +|-------|-------------|----|---------------------------------------------| +| field | string | 是 | 查询条件Field名称，具体可使用的用于查询的字段及其说明请看下面 - 查询参数介绍 | +| op | enum string | 是 | 操作符（枚举值：eq、neq、gt、gte、le、lte、in、nin、cs、cis） | +| value | 可变类型 | 是 | 查询条件Value值 | + +##### rules 表达式说明： + +##### 1. 操作符 + +| 操作符 | 描述 | 操作符的value支持的数据类型 | +|-----|-------------------------------------------|-----------------------------------------------| +| eq | 等于。不能为空字符串 | boolean, numeric, string | +| neq | 不等。不能为空字符串 | boolean, numeric, string | +| gt | 大于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | +| gte | 大于等于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | +| lt | 小于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | +| lte | 小于等于 | numeric，时间类型为字符串（标准格式："2006-01-02T15:04:05Z"） | +| in | 在给定的数组范围中。value数组中的元素最多设置100个，数组中至少有一个元素 | boolean, numeric, string | +| nin | 不在给定的数组范围中。value数组中的元素最多设置100个，数组中至少有一个元素 | boolean, numeric, string | +| cs | 模糊查询，区分大小写 | string | +| cis | 模糊查询，不区分大小写 | string | + +##### 2. 协议示例 + +查询 name 是 "Jim" 且 age 大于18小于30 且 servers 类型是 "api" 或者是 "web" 的数据。 + +```json +{ + "op": "and", + "rules": [ + { + "field": "name", + "op": "eq", + "value": "Jim" + }, + { + "field": "age", + "op": "gt", + "value": 18 + }, + { + "field": "age", + "op": "lt", + "value": 30 + }, + { + "field": "servers", + "op": "in", + "value": [ + "api", + "web" + ] + } + ] +} +``` + +#### page + +| 参数名称 | 参数类型 | 必选 | 描述 | +|-------|--------|----|-----------------------------------------------------------------------------------------------------------------------------------------------------| +| count | bool | 是 | 是否返回总记录条数。 如果为true，查询结果返回总记录条数 count，但查询结果详情数据 details 为空数组，此时 start 和 limit 参数将无效，且必需设置为0。如果为false，则根据 start 和 limit 参数，返回查询结果详情数据，但总记录条数 count 为0 | +| start | uint32 | 否 | 记录开始位置，start 起始值为0 | +| limit | uint32 | 否 | 每页限制条数，最大500，不能为0 | +| sort | string | 否 | 排序字段，返回数据将按该字段进行排序 | +| order | string | 否 | 排序顺序（枚举值：ASC、DESC） | + + +#### 查询参数介绍： + +| 参数名称 | 参数类型 | 描述 | +|--------------------|--------|--------------------------------------| +| cloud_id | string | 云资源ID | +| name | string | 名称 | +| vendor | string | 供应商（枚举值：tcloud、aws、azure、gcp、huawei） | +| account_id | string | 账号ID | +| region | string | 地域 | +| main_zones | string | 主可用区 | +| backup_zones | string | 备可用区 | +| cloud_vpc_id | string | 云vpcID | +| vpc_id | string | vpcID | +| network_type | string | 网络类型 | +| memo | string | 备注 | +| status | string | 状态 | +| domain | string | 域名 | +| cloud_created_time | string | lb在云上创建时间，标准格式：2006-01-02T15:04:05Z | +| cloud_status_time | string | lb状态变更时间，标准格式：2006-01-02T15:04:05Z | +| cloud_expired_time | string | lb过期时间，标准格式：2006-01-02T15:04:05Z | +| creator | string | 创建者 | +| reviser | string | 修改者 | +| created_at | string | 创建时间，标准格式：2006-01-02T15:04:05Z | +| updated_at | string | 修改时间，标准格式：2006-01-02T15:04:05Z | + +接口调用者可以根据以上参数自行根据查询场景设置查询规则。 + +### 调用示例 + +#### 获取详细信息请求参数示例 + +查询创建者是Jim的Cvm列表。 + +```json +{ + "filter": { + "op": "and", + "rules": [ + { + "field": "created_at", + "op": "eq", + "value": "Jim" + } + ] + }, + "page": { + "count": false, + "start": 0, + "limit": 500 + } +} +``` + +#### 获取数量请求参数示例 + +查询创建者是Jim的Cvm数量。 + +```json +{ + "filter": { + "op": "and", + "rules": [ + { + "field": "created_at", + "op": "eq", + "value": "Jim" + } + ] + }, + "page": { + "count": true + } +} +``` + +### 响应示例 + +#### 获取详细信息返回结果示例 + +```json +{ + "code": 0, + "message": "", + "data": { + "details": [ + { + "id": "00000001", + "cloud_id": "lb-123", + "name": "lb-test", + "vendor": "tcloud", + "bk_biz_id": -1, + "account_id": "0000001", + "region": "ap-hk", + "main_zones": [ + "ap-hk-1" + ], + "backup_zones": [ + "ap-hk-2", + "ap-hk-3" + ], + "cloud_vpc_id": "vpc-123", + "vpc_id": "00000002", + "network_type": "ipv4", + "domain": "", + "memo": "lb test", + "status": "init", + "private_ipv4_addresses": [ + "127.0.0.1" + ], + "private_ipv6_addresses": [], + "public_ipv4_addresses": [ + "127.0.0.2" + ], + "public_ipv6_addresses": [] + + } + ] + } +} +``` + +#### 获取数量返回结果示例 + +```json +{ + "code": 0, + "message": "ok", + "data": { + "count": 1 + } +} +``` + +### 响应参数说明 + +| 参数名称 | 参数类型 | 描述 | +|---------|--------|------| +| code | int32 | 状态码 | +| message | string | 请求信息 | +| data | object | 响应数据 | + +#### data + +| 参数名称 | 参数类型 | 描述 | +|---------|--------|----------------| +| count | uint64 | 当前规则能匹配到的总记录条数 | +| details | array | 查询返回的数据 | + +#### data.details[n] + +| 参数名称 | 参数类型 | 描述 | +|------------------------|--------------|---------------------------------------| +| id | string | 资源ID | +| cloud_id | string | 云资源ID | +| name | string | 名称 | +| vendor | string | 供应商（枚举值：tcloud、aws、azure、gcp、huawei） | +| bk_biz_id | int64 | 业务ID | +| account_id | string | 账号ID | +| region | string | 地域 | +| main_zones | string | 主可用区 | +| backup_zones | string | 备可用区 | +| cloud_vpc_id | string | 云vpcID | +| vpc_id | string | vpcID | +| network_type | string | 网络类型 | +| memo | string | 备注 | +| status | string | 状态 | +| domain | string | 域名 | +| private_ipv4_addresses | string array | 内网ipv4地址 | +| private_ipv6_addresses | string array | 内网ipv6地址 | +| public_ipv4_addresses | string array | 外网ipv4地址 | +| public_ipv6_addresses | string array | 外网ipv6地址 | + + +##### TCloud status 状态含义： + +| 状态值 | 含义 | +|-----|------| +| 0 | 创建中 | +| 1 | 正常运行 | + + diff --git a/docs/api-docs/web-server/docs/biz/security-group/query_security_group_rel_res_count.md b/docs/api-docs/web-server/docs/biz/security-group/query_security_group_rel_res_count.md new file mode 100644 index 0000000000..5c102fb2b8 --- /dev/null +++ b/docs/api-docs/web-server/docs/biz/security-group/query_security_group_rel_res_count.md @@ -0,0 +1,63 @@ +### 描述 + +- 该接口提供版本：v9.9.9+。 +- 该接口所需权限：业务访问。 +- 该接口功能描述：查询安全组关联的云上资源数量。 + +### URL + +POST /api/v1/cloud/bizs/{bk_biz_id}/security_groups/related_resources/query_count + +### 输入参数 + +| 参数名称 | 参数类型 | 必选 | 描述 | +|-----------|--------------|----|---------------| +| bk_biz_id | int64 | 是 | 业务ID | +| ids | string array | 是 | 安全组ID列表，最大100 | + +### 调用示例 + +```json +{ + "ids": [ + "00000001", + "00000002" + ] +} +``` + +### 响应示例 + +```json +{ + "code": 0, + "message": "ok", + "data": [ + { + "id": "00000001", + "cvm": 10, + "clb": 2, + "db": 0, + "container": 0 + } + ] +} +``` + +### 响应参数说明 + +| 参数名称 | 参数类型 | 描述 | +|---------|--------------|------| +| code | int32 | 状态码 | +| message | string | 请求信息 | +| data | object array | 响应数据 | + +#### data[n] + +| 参数名称 | 参数类型 | 描述 | +|-----------|--------|-------------| +| id | string | 安全组ID | +| cvm | int | 安全组关联的CVM数量 | +| clb | int | 安全组关联的CLB数量 | +| db | int | 安全组关联的DB数量 | +| container | int | 安全组关联的容器数量 | diff --git a/docs/api-docs/web-server/docs/biz/security-group/update_security_group_mgmt_attr.md b/docs/api-docs/web-server/docs/biz/security-group/update_security_group_mgmt_attr.md new file mode 100644 index 0000000000..5734b22e16 --- /dev/null +++ b/docs/api-docs/web-server/docs/biz/security-group/update_security_group_mgmt_attr.md @@ -0,0 +1,46 @@ +### 描述 + +- 该接口提供版本：v9.9.9+。 +- 该接口所需权限：业务-IaaS资源操作。 +- 该接口功能描述：更新安全组管理属性 + +### URL + +PATCH /api/v1/cloud/bizs/{bk_biz_id}/security_groups/mgmt_attrs/batch + +### 输入参数 + +| 参数名称 | 参数类型 | 必选 | 描述 | +|---------------|-----------|----|----------------| +| bk_biz_id | int64 | 是 | 业务ID | +| id | string | 是 | 安全组ID | +| manager | string | 否 | 负责人 | +| bak_manager | string | 否 | 备份负责人 | +| usage_biz_ids | int array | 否 | 使用业务列表，不支持改为-1 | + +### 调用示例 + +```json +{ + "id": "0000001", + "manager": "lihua", + "bak_manager": "hanmeimei", + "mgmt_biz_id": 123 +} +``` + +### 响应示例 + +```json +{ + "code": 0, + "message": "ok" +} +``` + +### 响应参数说明 + +| 参数名称 | 参数类型 | 描述 | +|---------|--------|------| +| code | int32 | 状态码 | +| message | string | 请求信息 | From 209ad48248a1c12d457d0423d6e8405d9e14d6b2 Mon Sep 17 00:00:00 2001 From: chenjr15 Date: Mon, 20 Jan 2025 19:56:47 +0800 Subject: [PATCH 2/2] fix: review issue --- .../biz/load-balancer/get_load_balancer.md | 5 +- .../load-balancer/list_biz_load_balancer.md | 10 +- .../list_biz_security_group_business.md | 72 ++++++++++++ .../list_security_group_rel_cvm_by_biz.md | 20 ++-- ...security_group_rel_load_balancer_by_biz.md | 107 +++++++++--------- .../load-balancer/get_load_balancer.md | 5 +- .../load-balancer/list_load_balancer.md | 10 +- 7 files changed, 150 insertions(+), 79 deletions(-) create mode 100644 docs/api-docs/web-server/docs/biz/security-group/list_biz_security_group_business.md diff --git a/docs/api-docs/web-server/docs/biz/load-balancer/get_load_balancer.md b/docs/api-docs/web-server/docs/biz/load-balancer/get_load_balancer.md index b1d972943a..45cef60b46 100644 --- a/docs/api-docs/web-server/docs/biz/load-balancer/get_load_balancer.md +++ b/docs/api-docs/web-server/docs/biz/load-balancer/get_load_balancer.md @@ -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 | 域名 | diff --git a/docs/api-docs/web-server/docs/biz/load-balancer/list_biz_load_balancer.md b/docs/api-docs/web-server/docs/biz/load-balancer/list_biz_load_balancer.md index e1fa73d67e..b88ad42b36 100644 --- a/docs/api-docs/web-server/docs/biz/load-balancer/list_biz_load_balancer.md +++ b/docs/api-docs/web-server/docs/biz/load-balancer/list_biz_load_balancer.md @@ -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": [ @@ -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", @@ -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 | 域名 | diff --git a/docs/api-docs/web-server/docs/biz/security-group/list_biz_security_group_business.md b/docs/api-docs/web-server/docs/biz/security-group/list_biz_security_group_business.md new file mode 100644 index 0000000000..55cc0e8d94 --- /dev/null +++ b/docs/api-docs/web-server/docs/biz/security-group/list_biz_security_group_business.md @@ -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资源总数 | \ No newline at end of file diff --git a/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_cvm_by_biz.md b/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_cvm_by_biz.md index b9da38f42f..d9ecddde27 100644 --- a/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_cvm_by_biz.md +++ b/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_cvm_by_biz.md @@ -10,14 +10,14 @@ POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{ ### 输入参数 -| 参数名称 | 参数类型 | 必选 | 描述 | -|------------|----------|----|--------------------------------------------| -| bk_biz_id | int64 | 是 | 安全组业务ID | -| sg_id | string | 是 | 安全组ID | -| res_biz_id | int64 | 是 | 关联资源业务ID | -| page | object | 是 | 分页设置 | -| filter | object | 是 | 查询过滤条件 | -| fields | []string | 否 | 查询条件Field名称，具体可使用的用于查询的字段及其说明请看下面 - 查询参数介绍 | +| 参数名称 | 参数类型 | 必选 | 描述 | +|------------|----------|----|---------------------------------------------------| +| bk_biz_id | int64 | 是 | 安全组业务ID | +| sg_id | string | 是 | 安全组ID | +| res_biz_id | int64 | 是 | 关联资源业务ID，当前业务为安全组管理业务时，可以任意关联资源业务id，否则只能指定当前业务id。 | +| page | object | 是 | 分页设置 | +| filter | object | 是 | 查询过滤条件 | +| fields | []string | 否 | 查询条件Field名称，具体可使用的用于查询的字段及其说明请看下面 - 查询参数介绍 | #### filter @@ -96,15 +96,12 @@ POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{ | sort | string | 否 | 排序字段，返回数据将按该字段进行排序 | | order | string | 否 | 排序顺序（枚举值：ASC、DESC） | - #### 查询参数介绍： | 参数名称 | 参数类型 | 描述 | |---------------------|--------|--------------------------------------| | cloud_id | string | 云资源ID | | name | string | 名称 | -| vendor | string | 供应商（枚举值：tcloud、aws、azure、gcp、huawei） | -| bk_biz_id | int64 | 业务ID | | bk_cloud_id | int64 | 云区域ID | | account_id | string | 账号ID | | region | string | 地域 | @@ -194,6 +191,7 @@ POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{ | 参数名称 | 参数类型 | 描述 | |------------------------|--------------|--------------------------------------| +| id | string | 资源ID | | cloud_id | string | 云资源ID | | name | string | 名称 | | vendor | string | 供应商（枚举值：tcloud、aws、azure、gcp、huawei） | diff --git a/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_load_balancer_by_biz.md b/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_load_balancer_by_biz.md index 51d091d6e4..7537753197 100644 --- a/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_load_balancer_by_biz.md +++ b/docs/api-docs/web-server/docs/biz/security-group/list_security_group_rel_load_balancer_by_biz.md @@ -10,14 +10,14 @@ POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{ ### 输入参数 -| 参数名称 | 参数类型 | 必选 | 描述 | -|------------|----------|----|--------------------------------------------| -| bk_biz_id | int64 | 是 | 安全组业务ID | -| sg_id | string | 是 | 安全组ID | -| res_biz_id | int64 | 是 | 关联资源业务ID | -| page | object | 是 | 分页设置 | -| filter | object | 是 | 查询过滤条件 | -| fields | []string | 否 | 查询条件Field名称，具体可使用的用于查询的字段及其说明请看下面 - 查询参数介绍 | +| 参数名称 | 参数类型 | 必选 | 描述 | +|------------|----------|----|---------------------------------------------------| +| bk_biz_id | int64 | 是 | 安全组业务ID | +| sg_id | string | 是 | 安全组ID | +| res_biz_id | int64 | 是 | 关联资源业务ID，当前业务为安全组管理业务时，可以任意关联资源业务id，否则只能指定当前业务id。 | +| page | object | 是 | 分页设置 | +| filter | object | 是 | 查询过滤条件 | +| fields | []string | 否 | 查询条件Field名称，具体可使用的用于查询的字段及其说明请看下面 - 查询参数介绍 | #### filter @@ -96,31 +96,28 @@ POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{ | sort | string | 否 | 排序字段，返回数据将按该字段进行排序 | | order | string | 否 | 排序顺序（枚举值：ASC、DESC） | - #### 查询参数介绍： -| 参数名称 | 参数类型 | 描述 | -|--------------------|--------|--------------------------------------| -| cloud_id | string | 云资源ID | -| name | string | 名称 | -| vendor | string | 供应商（枚举值：tcloud、aws、azure、gcp、huawei） | -| account_id | string | 账号ID | -| region | string | 地域 | -| main_zones | string | 主可用区 | -| backup_zones | string | 备可用区 | -| cloud_vpc_id | string | 云vpcID | -| vpc_id | string | vpcID | -| network_type | string | 网络类型 | -| memo | string | 备注 | -| status | string | 状态 | -| domain | string | 域名 | -| cloud_created_time | string | lb在云上创建时间，标准格式：2006-01-02T15:04:05Z | -| cloud_status_time | string | lb状态变更时间，标准格式：2006-01-02T15:04:05Z | -| cloud_expired_time | string | lb过期时间，标准格式：2006-01-02T15:04:05Z | -| creator | string | 创建者 | -| reviser | string | 修改者 | -| created_at | string | 创建时间，标准格式：2006-01-02T15:04:05Z | -| updated_at | string | 修改时间，标准格式：2006-01-02T15:04:05Z | +| 参数名称 | 参数类型 | 描述 | +|--------------------|--------|-------------------------------------| +| cloud_id | string | 云资源ID | +| name | string | 名称 | +| region | string | 地域 | +| zones | string | 可用区 | +| backup_zones | string | 备可用区 | +| cloud_vpc_id | string | 云vpcID | +| vpc_id | string | vpcID | +| lb_type | string | 网络类型 | +| memo | string | 备注 | +| status | string | 状态 | +| domain | string | 域名 | +| cloud_created_time | string | lb在云上创建时间，标准格式：2006-01-02T15:04:05Z | +| cloud_status_time | string | lb状态变更时间，标准格式：2006-01-02T15:04:05Z | +| cloud_expired_time | string | lb过期时间，标准格式：2006-01-02T15:04:05Z | +| creator | string | 创建者 | +| reviser | string | 修改者 | +| created_at | string | 创建时间，标准格式：2006-01-02T15:04:05Z | +| updated_at | string | 修改时间，标准格式：2006-01-02T15:04:05Z | 接口调用者可以根据以上参数自行根据查询场景设置查询规则。 @@ -190,7 +187,7 @@ POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{ "bk_biz_id": -1, "account_id": "0000001", "region": "ap-hk", - "main_zones": [ + "zones": [ "ap-hk-1" ], "backup_zones": [ @@ -199,7 +196,8 @@ POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{ ], "cloud_vpc_id": "vpc-123", "vpc_id": "00000002", - "network_type": "ipv4", + "network_type": "open", + "ip_version": "ipv4", "domain": "", "memo": "lb test", "status": "init", @@ -211,7 +209,6 @@ POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{ "127.0.0.2" ], "public_ipv6_addresses": [] - } ] } @@ -247,28 +244,26 @@ POST /bizs/{bk_biz_id}/security_groups/{sg_id}/related_resources/biz_resources/{ #### data.details[n] -| 参数名称 | 参数类型 | 描述 | -|------------------------|--------------|---------------------------------------| -| id | string | 资源ID | -| cloud_id | string | 云资源ID | -| name | string | 名称 | -| vendor | string | 供应商（枚举值：tcloud、aws、azure、gcp、huawei） | -| bk_biz_id | int64 | 业务ID | -| account_id | string | 账号ID | -| region | string | 地域 | -| main_zones | string | 主可用区 | -| backup_zones | string | 备可用区 | -| cloud_vpc_id | string | 云vpcID | -| vpc_id | string | vpcID | -| network_type | string | 网络类型 | -| memo | string | 备注 | -| status | string | 状态 | -| domain | string | 域名 | -| private_ipv4_addresses | string array | 内网ipv4地址 | -| private_ipv6_addresses | string array | 内网ipv6地址 | -| public_ipv4_addresses | string array | 外网ipv4地址 | -| public_ipv6_addresses | string array | 外网ipv6地址 | - +| 参数名称 | 参数类型 | 描述 | +|------------------------|--------------|----------| +| id | string | 资源ID | +| cloud_id | string | 云资源ID | +| name | string | 名称 | +| bk_biz_id | int64 | 业务ID | +| region | string | 地域 | +| zones | string | 主可用区 | +| backup_zones | string | 备可用区 | +| cloud_vpc_id | string | 云vpcID | +| vpc_id | string | vpcID | +| lb_type | string | 负载均衡类型 | +| ip_version | string | IP版本 | +| memo | string | 备注 | +| status | string | 状态 | +| domain | string | 域名 | +| private_ipv4_addresses | string array | 内网ipv4地址 | +| private_ipv6_addresses | string array | 内网ipv6地址 | +| public_ipv4_addresses | string array | 外网ipv4地址 | +| public_ipv6_addresses | string array | 外网ipv6地址 | ##### TCloud status 状态含义： diff --git a/docs/api-docs/web-server/docs/resource/load-balancer/get_load_balancer.md b/docs/api-docs/web-server/docs/resource/load-balancer/get_load_balancer.md index 6e2aaed5a5..5df3662224 100644 --- a/docs/api-docs/web-server/docs/resource/load-balancer/get_load_balancer.md +++ b/docs/api-docs/web-server/docs/resource/load-balancer/get_load_balancer.md @@ -82,11 +82,12 @@ POST /api/v1/cloud/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 | 域名 | diff --git a/docs/api-docs/web-server/docs/resource/load-balancer/list_load_balancer.md b/docs/api-docs/web-server/docs/resource/load-balancer/list_load_balancer.md index 3d23b43429..ed786ee705 100644 --- a/docs/api-docs/web-server/docs/resource/load-balancer/list_load_balancer.md +++ b/docs/api-docs/web-server/docs/resource/load-balancer/list_load_balancer.md @@ -103,11 +103,12 @@ POST /api/v1/cloud/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 | 域名 | @@ -259,11 +260,12 @@ POST /api/v1/cloud/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 | 域名 |