i2UP接口文档

# NAS 同步规则

SDK类名：/nas/NAS

# nas 同步 - 组 新建

新建nas规则

SDK方法名：createNAS

# URL

//nas/sync

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
band_width String 否 带宽控制：12301:00-02:002m,3412:00-13:006m，按照此类型拼接，没有可不传
bk_path String 否 E:\t\ 灾备机路径
bk_uuid String 否 67E33CDB-D75B-15B3-367D-50C764F5A26F 灾备机uuid
compress Number 否 0 压缩：0-2，0为关，1 2 为压缩等级
cmp_switch Number 否 0 比较计划，0: 关; 1: 开;
cmp_sync_file Number 否 1 比较计划是否同步文件:

1：同步（默认值） 0：不同步 | cmp_file_check | Number | 否 | 0 | 比较计划，校验方式，0：md5；1：文件大小和时间； | cmp_schedule | Array | 否 | | 比较计划，策略，字符串数组，元素是cron表达式；

每天：0 0 12,14,16 ? * * *//每天的12点，14点，16点触发 ,分别选取了12 时，14时，16时；

每周：5 4 12 4,5,6 ? * *//每个星期的星期四，星期五，星期六的12点4分5秒触发；

每月：0 10 16 ? 2,8,10 * *//每个月的2,8,10号的16点10分触发； | encrypt_switch | Number | 否 | 0 | 加密：0关1开； | secret_key | String | 否 | | 加密，密钥； | nas_name | String | 否 | test2 | 规则名称 | nas_type | String | 否 | 0 | 同步类型：0：直接同步；1：同步机同步； | sync_path | String | 否 | | 同步机路径 | sync_uuid | String | 否 | | 同步机uuid，没有同步机传空 | wk_list | Array | 否 | | 工作机路径 |   wk_uuid | String | 否 | 67E33CDB-D75B-15B3-367D-50C764F5A26F | 工作机uuid |   wk_path | String | 否 | E:\nas\ | 工作机路径 | file_type_filter_switch | Number | 否 | | 文件类型过滤开关：0 表示包含，1表示排除 | file_type_filter | String | 否 | | 文件类型过滤：正则表达式串（可以包含多个，用空格分隔） | thread_num | Number | 否 | | 并行任务数 | mirr_sync_attr | Number | 否 | | 文件安全属性 |

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。

# nas 同步 - 组 获取单个

URL参数为 group_uuid

SDK方法名：describeNASGroup

# URL

//nas/sync/:uuid([A-F0-9-]+)/group

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
  nas Object 否
    sync_node_name String 否 N3_72.75
    wk_node_name String 否 N3_72.75
    bk_node_name String 否 N3_72.75
    band_width String 否
    cmp_sync_file Number 否 1 比较计划是否同步文件:

1：同步（默认值） 0：不同步 |     cmp_schedule | Array | 否 | | |     cmp_file_check | Number | 否 | 0 | |     cmp_switch | Number | 否 | 0 | |     compress | String | 否 | 0 | |     create_time | String | 否 | 1540524255 | |     encrypt_switch | String | 否 | 0 | |     random_str | String | 否 | 611C539F-2579-6839-82B3-0DB267744396 | |     secret_key | String | 否 | | |     id | String | 否 | 17 | |     nas_name | String | 否 | test | |     user_uuid | String | 否 | 1BCFCAA3-E3C8-3E28-BDC5-BE36FDC2B5DC | |     bk_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | |     bk_path | String | 否 | H:\nas1\ | |     sync_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | |     sync_path | String | 否 | H:\nas\ | |     group_uuid | String | 否 | 5C908510-E629-70AA-F747-1D26C71A51C7 | |     nas_uuid | String | 否 | 87759EC7-0571-6450-3741-0D68BA454470 | |     nas_type | Number | 否 | 1 | |     cmp_node_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | |     wk_list | Array | 否 | | |       wk_uuid | String | 否 | C02B76DB-EBE8-E029-B645-072B2E1A7460 | |       wk_path | String | 否 | E:\test\ | |       nas_uuid | String | 否 | 87759EC7-0571-6450-3741-0D68BA454470 | |       wk_node_name | String | 否 | N3_72.75 | |

# nas 同步 - 组 编辑

URL参数为 group_uuid，PUT参数基本同新建一样，如下是多出的参数

SDK方法名：modifyNAS

# URL

//nas/sync/:uuid([A-F0-9-]+)/group

# Method

PUT

# Request

名称 类型 必选 初始值 简介 Mock规则
random_str String 否 11111111-1111-1111-1111-111111111111 用于防止并发修改的随机串，获取单个时拿到，编辑完成原样传回

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。

# nas 同步 - 获取 列表

获取列表参数详见【节点 - 获取列表】接口

SDK方法名：listNAS

# URL

//nas/sync

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
limit Number 否 10
page Number 否 1

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] success
  info_list Array 否 3
    band_width String 否 100:00-23:592m
    random_str String 否 D55EF18A-DD02-BAC2-B4D9-F1D119E86ABF
    encrypt_switch String 否 0
    sync_node_name String 否
    wk_node_name String 否 N3_72.75
    bk_node_name String 否 N3_72.75
    username String 否 admin
    bk_path String 否 E:\test2\
    bk_uuid String 否 C02B76DB-EBE8-E029-B645-072B2E1A7460
    group_uuid String 否 36175237-ACA0-A365-7858-D29EA8D5CD7E
    nas_name String 否 qwdqwd
    nas_type Number 否 0
    nas_uuid String 否 A6C95BF5-CF94-A90A-3EA1-509323BDE8E7
    sync_path String 否
    sync_uuid String 否
    wk_path String 否 E:\test\
    wk_uuid String 否 C02B76DB-EBE8-E029-B645-072B2E1A7460
  total Number 否 3

# nas 同步 - 获取 状态

SDK方法名：listNASStatus

# URL

//nas/sync/status

# Method

GET

# Request

名称 类型 必选 初始值 简介 Mock规则
nas_uuids Array 否 ["11111111-1111-1111-1111-111111111111"] 规则uuid

# Response

名称 类型 必选 初始值 简介 Mock规则
data Object 否
  status Array 否 2
    sync_status String 否 @pick(["STOP","EXECUTING","IDLE","DEAD","FINISH","SWITCH","UNKNOWN","VP_START","VP_CHECK","VP_CFG","VP_CBT"]) 同步机状态
    status String 否 @pick(["STOP","EXECUTING","IDLE","DEAD","FINISH","SWITCH","UNKNOWN","VP_START","VP_CHECK","VP_CFG","VP_CBT"]) 工作机状态
    nas_uuid String 否 @guid 规则uuid
  code Number 否 0
  message String 否
msg String 否
ret Number 否 200

# nas 同步 - 操作：启停

SDK方法名：

启动：startNAS

停止：stopNAS

# URL

//nas/sync/operate

# Method

POST

# Request

名称 类型 必选 初始值 简介 Mock规则
nas_uuids Array 否 [11111111-1111-1111-1111-111111111111] 规则uuid
operate String 否 start start, stop

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。

# nas 同步 - 删除

SDK方法名：deleteNAS

# URL

//nas/sync

# Method

DELETE

# Request

名称 类型 必选 初始值 简介 Mock规则
nas_uuids Array 否 ["11111111-1111-1111-1111-111111111111"] 规则uuid

# Response

名称 类型 必选 初始值 简介 Mock规则
ret Number 否 200
msg String 否
data Object 否
  code Number 否 0
  message String 否 [0] 操作成功。
Last Updated: 5/13/2020, 3:56:32 AM