云服务器内容精选

  • 请求示例 HTTP的示例 POST /controller/campus/baseservice/api/v1/filemgr/files/combine-fileinfo HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy { "fileName" : "test", "description" : "插件文件", "addCombineFileInfos" : [ { "fileName" : "plugin.ova", "fileType" : 19, "localFilePath" : "C:\\fakepath\\test1.ova", "fileSize" : 11 } ] }
  • 响应参数 返回状态码为200:保存文件信息成功返回。返回体参考AddFileInfoResponse 表4 AddCombineFileInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string - - 错误码。 0 : 无错误 1 : 参数校验或数据访问错误 详细信息见errMsg "0" errMsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-10个列表项,详细请参见表3。 组合文件信息返回 - 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:服务内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:保存文件信息成功返回。返回体参考AddFileInfoResponse HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errCode" : "0", "errMsg" : "", "data" : [ { "errCode" : "0", "errMsg" : "test.xml Add success!", "fileId" : "549d0eec-9d6a-40c2-ab36-c7239e5fe409", "fileName" : "test.xml" } ] } 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:服务内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 AddCombineFile 是 REFERENCE 详细请参见表2。 上传插件文件基本信息。 插件文件:文件类型固定参数22(入参无需设置) 插件文件由以下三个文件组合而成:(addCombineFileInfos的入参) (三个文件每个必有且仅有一个作为入参) 插件文件(.ova):文件类型入参19 插件密钥(.pem):文件类型入参23 插件签名(.asc):文件类型入参24 - 表2 AddCombineFile对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 fileName 是 string 0~64个字符。 - 文件名称 "test" description 否 string 0~255个字符。 - 文件描述 该字段对应UI页面上是:UI【描述】 "插件文件" addCombineFileInfos 是 ARRAY_REFERENCE 0-3个列表项,详细请参见表3。 文件信息列表。 上传插件时由三个文件组成,详见上传插件文件信息接口入参描述 - 表3 AddCombineFileInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 fileName 是 string 0~64个字符。 - 文件名称 "plugin.ova" fileType 是 int32 [0-100] - 文件类型 取值详见上传组合文件信息接口的入参描述 19 localFilePath 是 string 0~1000个字符。 - 文件上传时的本地路径 "C:\\fakepath\\test1.ova" fileSize 是 int64 [0-2147483647] - 文件大小(B) 文件类型对应大小限制 插件文件 20971520 插件密钥 4096 插件签名 2048 11
  • 响应示例 返回状态码为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
  • 响应参数 返回状态码为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/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
  • 请求示例 HTTP的示例 GET /controller/campus/baseservice/api/v1/filemgr/files?pageIndex=1&pageSize=20&sort=+fileName&filter=fileType::20|keyword::test|feature::1|status::1 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:文件查询成功返回,响应体参考QueryFileResponse HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errCode" : "0", "errMsg" : "", "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 1, "fileInfoList" : [ { "fileId" : "7d4ea473-dc8b-4acc-8cf9-0a550cbb09e6", "subFileDetails" : [ { "fileId" : "7d4ea473-dc8b-4acc-8cf9-0a550cbb09e6", "subFileDetails" : [ { ... } ], "currentUserUpload" : true, "fileType" : 20, "feature" : 22, "version" : "1.1", "fileName" : "test.xml", "description" : "文件描述", "tenantName" : "tenant", "fileSize" : "0", "offset" : 0, "sizeUnit" : "B", "uploadProgress" : 100, "createTime" : "2022-10-25 21:01:35", "iconString" : null, "storageTypesSupport" : [ { ... } ], "fileServerName" : " FusionInsight ", "manualRecord" : 0, "status" : 1, "needToReboot" : false, } ], "currentUserUpload" : true, "fileType" : 20, "feature" : 22, "version" : "1.1", "fileName" : "test.xml", "description" : "文件描述", "tenantName" : "tenant", "fileSize" : "0", "offset" : 0, "sizeUnit" : "B", "uploadProgress" : 100, "createTime" : "2022-10-25 21:01:35", "iconString" : "", "storageTypesSupport" : [ "" ], "fileServerName" : "FusionInsight", "manualRecord" : 0, "status" : 1, "needToReboot" : false } ] } 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:服务内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • URI /controller/campus/baseservice/api/v1/filemgr/files 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [0-2147483647] - 当前页码。默认为1 1 pageSize 否 int32 [0-1000] - 分页大小。默认为20 20 sort 否 string 0~100个字符。 - sort: 排序方式。默认文件名排序 可根据: displayName、uploadProgress、type tenantName、status、size、createTime 的文件信息字段进行排序, 传参字段前+为正序-为倒序 "+fileName" filter 是 string 0~255个字符。 - 查询过滤条件 filter支持字段: | fileType(必填) | 查询的文件类型 | | :----- | :----- | | 25 | CPE软件包 | | 22 | 插件 | | 20 | 设备license | | 1 | 镜像包 | | keyword | 关键字 | | :----- | :----- | | 匹配范围 | 文件名、版本、描述、租户名| | feature | 查询的插件类型| | :----- | :----- | | 0 | wireless | | 1 | IOT | | status | 查询的插件状态,只有传feature参数时生效 | | :----- | :----- | | 1 | 解析完成 | filter格式控制 参数名::参数值 分隔符| "fileType::20|keyword::test|feature::1|status::1"
  • 响应示例 返回状态码为200:删除文件返回结果。响应体参考DeleteFileResponse HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errCode" : "0", "errMsg" : "", "successList" : [ { "fileName" : "test.xml", "fileId" : "" } ], "failList" : [ { "fileName" : "", "errCode" : "0", "errMsg" : "" } ] } 返回状态码为400:参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:服务内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 POST /controller/campus/baseservice/api/v1/filemgr/files/action/batch-delete 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 [ "addc4e07-b534-4139-888a-5d44c8c7fda3" ]
  • 响应参数 返回状态码为200:删除文件返回结果。响应体参考DeleteFileResponse 表3 DeleteFileResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string - - 错误码。 0 : 无错误 1 : 参数校验或数据访问错误 详细信息见errMsg "0" errMsg string - - 错误信息。 "" successList ARRAY_REFERENCE 详细请参见表4。 删除成功的文件列表。 - failList ARRAY_REFERENCE 详细请参见表5。 删除失败的文件列表。 - 表4 DeleteSuccessFile对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 fileName string - - 文件名 "test.xml" fileId string - - 文件Id - 表5 DeleteFailFile对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 fileName string - - 文件Id - errCode string - - 错误码。 0 : 无错误 1 : 参数校验或数据访问错误 详细信息见errMsg "0" errMsg string - - 错误信息。 "" 返回状态码为400:参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:服务内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 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