Skip to content
New issue

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

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

Already on GitHub? # to your account

[节点管理-评审会] 前端下载excel模板需要优化 #2437

Open
chalice-1831 opened this issue Sep 23, 2024 · 1 comment
Open

[节点管理-评审会] 前端下载excel模板需要优化 #2437

chalice-1831 opened this issue Sep 23, 2024 · 1 comment
Assignees
Labels
backlog 需求初始状态,等待产品进行评估 for test 可以在测试环境进行验收 kind/feature 功能

Comments

@chalice-1831
Copy link
Collaborator

chalice-1831 commented Sep 23, 2024

背景

现用户有对 节点管理 的Agent安装方式——Excel导入的模板存在字段是否可为空、样例不清楚、字段含义不清楚、填写内容非下拉框选择的需求,请求优化导入模板。

功能

由于用户在使用安装agent时想使用excel导入的形式,但是不是很清楚哪些是必填项,哪些不是必填项,留空是什么意思,不填可以吗?错了会产生什么后果?此处的模板需要进行完善说明

image

为每一个字段进行单独说明(可在每列字段下加一个简要说明或可单独加一个sheet标明每个字段的含义)

image

尽可能多地将客户需要手动填写的内容转换成下拉框的形式(IP、用户名、密码等这些个性化强的字段除外)

image

功能实现

建议的方案

实现方案

功能自测

代码变更覆盖功能点需要自测并截图

image

描述代码变更涉及功能点及自测截图

image

描述代码变更涉及功能点及自测截图

...

@chalice-1831 chalice-1831 added kind/feature 功能 backlog 需求初始状态,等待产品进行评估 labels Sep 23, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Oct 28, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Oct 29, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Oct 29, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Oct 29, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Oct 30, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Oct 31, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Oct 31, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Nov 4, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Nov 4, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Nov 4, 2024
@chalice-1831 chalice-1831 added the for test 可以在测试环境进行验收 label Nov 4, 2024
@chalice-1831
Copy link
Collaborator Author

功能描述

上传并解析excel模板

请求参数

{{ common_args_desc }}

接口参数

字段 类型 必选 描述
file form-data 上传待解析的excel文件

请求参数示例

{

    "bk_app_code": "esb_test",

    "bk_app_secret": "xxx",

    "bk_username": "admin",

    "bk_token": "xxx",

    "file": "bk_nodeman_info.xlsx"

}

返回结果示例

// success:
{
    "result": true,
    "data": {
        "host": [
            {
                "inner_ip": "1.1.1.1",
                "inner_ipv6": null,
                "os_type": "LINUX",
                "install_channel_id": 0,
                "port": 22,
                "account": "root",
                "auth_type": "PASSWORD",
                "outer_ip": null,
                "login_ip": null,
                "bk_biz_id": 2,
                "bk_cloud_id": 0,
                "ap_id": 1,
                "bt_speed_limit": null,
                "bk_addressing": "static",
                "enable_compression": null,
                "password": "A3aaQqhHtUiPTaeuGMVaYJi3q3H259CGcnSWSr0SAbW4/x8JmlARoLAtBCezmy4Mw9QOU9imGKD7Xk7XGaTD7b4tjgQL9neI2rFnzkhO7vM4pu6U3u1TMi5m3WPrwsU8cXWpKRHyRwpz1qRAFV3donNRmsuMWvv/lmauAoLvFSmvsAqSzQckN6Sp3ihaYCrB7uNuAw1zW+Rwg5F0qf7Km6H5uR8+w6PhfqjDx0S6RJDqQX9FXd5QvKj2Jg30yAhWMifCkpwEtJpHC9cJK7hZxS6cmJ46va2u0JTOUtFwbFsIdbrHCIjp6xrcSjDJILJRseLmhKNWMteNSeMLxs6NIg=="
            }
        ],
        "error_message": []
    },
    "code": 0,
    "message": ""
}

// failed
{
    "result": true,
    "data": {
        "host": [],
        "error_message": [
            "第5行:install_channel_id不能为空或格式错误,请依照模板填写,不要修改模板"
        ]
    },
    "code": 0,
    "message": ""
}

返回结果参数说明

response

字段 类型 描述
result bool 请求成功与否。true:请求成功;false请求失败
code int 错误编码。 0表示success,>0表示失败错误
message string 请求失败返回的错误信息
data array 请求返回的数据,见data定义

data

字段 类型 描述
host array 解析到的主机信息,密码/密钥部分已加密
error_message array 错误信息,"第 x 行: xxxx"

host

字段 类型 描述
inner_ip string 内网ipv4地址
inner_ipv6 string 内网ipv6地址
os_type string 操作系统类型: LINUX、WINDOWS、AIX、DARWIN、SOLARIS
install_channel_id int 安装通道id
port int 登录端口
account string 登录账号
auth_type string 凭据校验类型:PASSWORD密码、KEY密钥
outer_ip string 外网ipv4地址
login_ip string 登录ip
bk_biz_id int 业务id
bk_cloud_id int 云区域id
ap_id int 接入点id
bt_speed_limit string 传输限速
bk_addressing string 寻址方式
enable_compression bool 数据压缩开启开关
password string auth_type为PASSWORD对应的凭据id
key string auth_type为KEY对应的凭据id

chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Nov 15, 2024
chalice-1831 added a commit to chalice-1831/bk-nodeman that referenced this issue Jan 21, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
backlog 需求初始状态,等待产品进行评估 for test 可以在测试环境进行验收 kind/feature 功能
Projects
None yet
Development

No branches or pull requests

3 participants