-
响应示例 返回状态码为200：返回查询的配置文件变更信息 HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF8
{
"code": 0,
"description": "enterprise.app.configfilemgr.openapi.configchange.success",
"data": {
"configChangeInfo": [{
"neDn": "657770f1-4b9b-3112-a9d3-57b31851163f",
"changeTime": 1599135850363,
"oldFile": "20200903202115R.cfg",
"newFile": "20200903202357R.cfg",
"fileType": "r",
"added": null,
"modified": null,
"baseModified": null,
"deleted": null,
"addNum": 0,
"modifyNum": 3,
"deleteNum": 0
}],
"curPage": 1,
"totalPage": 1
}
}
-
URI /rest/openapi/configfile/configchange 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 changeTime 是 int64 - - 起始时间（UTC时间，精确到毫秒），表示查询从该时间到现在的配置文件变更信息。 1598889600000 pageNo 是 int32 - - 指定从第几页开始返回查询结果集，从1开始 1 pageSize 是 int32 - - 每页大小，最小值为1，最大值为100。 10
-
请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-AC
CES S-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/configfile/configchange?changeTime=1598889600000&pageNo=1&pageSize=10' HTTP的示例 GET /rest/openapi/configfile/configchange?changeTime=1598889600000&pageNo=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
-
响应参数 返回状态码为200：返回查询的配置文件变更信息 表2 NorthCfgChangeResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 - - 操作返回码（0：成功；非0：失败）。 0 description string - - 接口调用结果的描述信息。 "enterprise.app.configfilemgr.openapi.configchange.success" data REFERENCE 详细请参见表3。 配置文件变更信息 - 表3 NorthCfgChangeData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 configChangeInfo ARRAY_REFERENCE 详细请参见表4。 配置文件变更信息 - curPage int32 - - 当前页数 1 totalPage int32 - - 总页数 1 表4 NorthCfgChangeModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 neDn string - - 网元的唯一标识 "657770f1-4b9b-3112-a9d3-57b31851163f" changeTime int64 - - 变更时间（UTC时间，精确到毫秒） 1599135850363 oldFile string - - 变更前文件名称 "20200903202115R.cfg" newFile string - - 变更后文件名称 "20200903202357R.cfg" fileType string - - 备份文件类型，"r"：运行配置；“s”:启动配置 "r" added string - - 新增的命令 - modified string - - 修改的命令 - baseModified string - - 修改前的命令 - deleted string - - 删除的命令 - addNum int32 - - 新增的行数 0 modifyNum int32 - - 修改的行数 3 deleteNum int32 - - 删除的行数 0
-
请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/conffilemgmtservice/v1/conffile/action/refresh?condition={"sessionId":"1042","operateType":"backup"}' HTTP的示例 GET /rest/openapi/conffilemgmtservice/v1/conffile/action/refresh?condition={"sessionId":"1042","operateType":"backup"} HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
-
响应示例 返回状态码为200：获取查询到的设备信息 HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF8
{
"resultList": [{
"neDn": "e1daadbb-71cd-11e9-82c8-000c291661a5",
"neName": "huawei",
"errorCode": 0,
"errorMsg": "The device is backup.",
"startupErrorCode": 0,
"runningErrorCode": 0,
"backupType": null,
"startupFileName": null,
"runningFileName": null
}],
"error_code": 0,
"error_msg": "Successful.",
"sessionId": 1591,
"briefErrorCode": 0,
"briefErrorMsg": null,
"status": 1
}
-
URI /rest/openapi/conffilemgmtservice/v1/conffile/action/refresh 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 condition 是 string - - 查询条件的格式：{"sessionId":"", "operateType":""} sessionId：备份的sessionId。必填字段，必须是大于0的数值 operateType：备份的类型。必填字段，类型列举：备份：backup，恢复：recover，运行至启动：runtostart {"sessionId":"1042","operateType":"backup"}
-
响应示例 返回状态码为200：获取查询到的设备信息 HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF8
{
"resultList": [{
"neDn": "e1daadbb-71cd-11e9-82c8-000c291661a5",
"neName": "huawei",
"startupErrorCode": 0,
"runningErrorCode": 0,
"backupType": null,
"startupFileName": null,
"runningFileName": null,
"errorCode": 0,
"errorMsg": ""
}],
"error_code": 0,
"error_msg": "Successful.",
"sessionId": 1589,
"briefErrorCode": 0,
"briefErrorMsg": null,
"status": 0
}
-
请求示例 cURL的示例 curl -k -s -L -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/conffilemgmtservice/v1/conffile/action/backup' -d '[
"e1daadbb-71cd-11e9-82c8-000c291661a5"
]' HTTP的示例 POST /rest/openapi/conffilemgmtservice/v1/conffile/action/backup HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
[
"e1daadbb-71cd-11e9-82c8-000c291661a5"
]
-
响应参数 返回状态码为200：获取查询到的设备信息 表2 OperateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 error_code int32 - 0 错误码。 - error_msg string - Successful. 错误消息。 - resultList ARRAY_REFERENCE 详细请参见表3。 设备恢复结果 - sessionId int64 - - 会话id - briefErrorCode int32 - 0 下发操作的结果（0：全部成功，1：全部失败，2：部分成功） - briefErrorMsg string - - 整体操作结果描述 - status int32 - 0 下发操作的进展（0：初始化，1：运行中，2：结束） - 表3 DeviceOperateResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 neDn string 0~100个字符。 - 设备dn - neName string 0~255个字符。 - 设备名称 - errorCode int32 - 0 失败码 - startupErrorCode int32 - 0 启动配置错误码 - runningErrorCode int32 - 0 运行配置错误码 - backupType string 0~255个字符。 - 备份类型 - errorMsg string - - 失败原因 - startupFileName string 0~255个字符。 - 启动配置文件名 - runningFileName string 0~255个字符。 - 运行配置文件名 -
-
响应参数 返回状态码为200：导入文件结果 表3 NorthUploadCfgResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 导入文件结果错误码，成功0，失败1 "0" addFileInfoResultDto REFERENCE 详细请参见表4。 结果对象 - 表4 NorthCfgOperateResultModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 result string - - 导入文件结果 "20200109111354R.cfg: Upload Success"
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 data 是 REFERENCE 详细请参见表2。 导入文件数据 - 表2 NorthCfgFileImportModel对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 file 是 file - - 文件 "/opt/20200109111354R.cfg" fileName 是 string 0~64个字符。 - 文件名称 "20200109111354R.cfg" displayName 是 string 0~64个字符。 - 文件显示名称 "20200109111354R.cfg" type 是 int32 - - 文件类型，配置文件为21 21 size 是 int32 - - 文件大小，单位Byte 4247 localFilePath 否 string 0~1000个字符。 - 文件上传时的本地路径 "filepath" desc 否 string 0~255个字符。 - 文件描述 "string" Md5 是 string - - 文件的Hash值 "616BF378ACDD6ABF31EBCB06CE02B8D5" pieceEnable 否 boolean true false false 文件分段，配置文件为False false
-
请求示例 cURL的示例 curl -k -s -L -i -X POST -H 'Content-Type: multipart/form-data' -H 'Accept: multipart/form-data' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/openapi/conffilemgmtservice/v1/file/upload' -d '{
"file" : "/opt/20200109111354R.cfg",
"fileName" : "20200109111354R.cfg",
"displayName" : "20200109111354R.cfg",
"type" : 21,
"size" : 4247,
"localFilePath" : "filepath",
"desc" : "string",
"Md5" : "616BF378ACDD6ABF31EBCB06CE02B8D5",
"pieceEnable" : false
}' HTTP的示例 POST /openapi/conffilemgmtservice/v1/file/upload HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: multipart/form-data
Accept: multipart/form-data
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
{
"file" : "/opt/20200109111354R.cfg",
"fileName" : "20200109111354R.cfg",
"displayName" : "20200109111354R.cfg",
"type" : 21,
"size" : 4247,
"localFilePath" : "filepath",
"desc" : "string",
"Md5" : "616BF378ACDD6ABF31EBCB06CE02B8D5",
"pieceEnable" : false
}
