接口功能介绍
调用此接口可以上传文件到弹性云主机、物理机内部
说明:仅支持批量上传文件到弹性云主机或物理机内部,不支持混合上传,仅支持Linux系统
接口约束
1)弹性云主机、物理机必须处于运行状态;
2)弹性云主机、物理机中必须安装天翼云云助手且服务处于运行状态。
URI
POST /v4/cloud-assistant/send-file
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 88f8888888dd88ec888888888d888d8b | |
instanceIDs | 是 | String | 待下发文件的弹性云主机、物理机ID列表, 使用 , 分割 | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa,d8e8888-8ed8-88b8-88cb-888f8b8cf8fb | |
fileName | 是 | String | 文件名称,长度不超过128个字符 | testFile.txt | |
description | 否 | String | 文件描述,长度不超过512个字符 | test file | |
fileContent | 是 | String | 加密的文件内容,base64编码长度不可超过24KB | ZWNobyB0ZXN0 | |
targetDirectory | 是 | String | 下发文件的目标路径 | /home/user | |
fileOwner | 否 | String | 文件所属用户,只针对linux实例,默认root | root | |
fileGroup | 否 | String | 文件用户组,只针对linux实例,默认root | root | |
fileMode | 否 | String | 文件权限,只针对linux实例,默认644 | 644 | |
overwrite | 否 | Boolean | 是否覆盖,如果目标路径下同名文件已经存在,true:覆盖,false:不覆盖。默认false | false |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800 为成功,900 为失败) | 800 | |
errorCode | String | 业务细分码,为product.module.code三段式码,详见错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Param is null | |
description | String | 失败时的错误描述,一般为中文描述 | 请求参数错误 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
invokedID | String | 执行ID | a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "200000003335",
"instanceIDs": "b29d96af-1ab8-378e-a07c-98e7675473f6",
"fileName": "test-0221-6",
"description": "testDescription",
"fileContent": "gAAAAABnt21KrgszjPqUkhE7LplwwJthvJ-BQYGC5F7b3dR6uSijUnl0EBxy9HuN56foXtoCHg7WsZAg7CyU4WGW0Nxx-vtWfDWpRYgc-hf-RGjoRDz3Mvc=",
"targetDirectory": "/tmp",
"fileOwner": "root",
"fileGroup": "root",
"fileMode": "0644",
"overwrite": false
}
响应示例
{
"returnObj": {
"invokedID": "a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码