接口功能介绍
调用此接口可以查询上传到弹性云主机或物理机的文件的结果
接口约束
无
URI
POST /v4/cloud-assistant/describe-send-file-results
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 88f8888888dd88ec888888888d888d8b | |
| fileName | 否 | String | 文件名称 | testFile.txt | |
| invokedID | 否 | String | 执行ID | a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf | |
| pageNo | 否 | Integer | 当前页码，默认值为1 | 1 | |
| pageSize | 否 | Integer | 分页查询时设置的每页行数，最大值为100，默认为10 | 10 |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800 为成功，900 为失败） | 800 | |
| errorCode | String | 业务细分码，为product.module.code三段式码，详见错误码说明。 | ||
| message | String | 失败时的错误描述，一般为英文描述。 | Param is null | |
| description | String | 失败时的错误描述，一般为中文描述。 | 请求参数错误 | |
| returnObj | Object | 成功时返回的数据。 | returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Object | 命令执行结果集合 | invocation | |
| pageNo | Integer | 当前页码 | 1 | |
| totalCount | Integer | 命令总个数 | 10 | |
| pageSize | Integer | 每页行数 | 10 |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|
表 invocation
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| createTime | String | 文件下发任务创建时间 | 2024-07-22T09:15:55Z | |
| invocationRecordStatus | String | 文件下发总的执行状态，取值范围： Pending：下发中，有一台云主机未下发，则总的状态为下发中； Running：运行中，有云主机中文件下发进程为运行中，则总的执行状态为运行中； Finished：已完成，所有云主机文件下发全部完成执行； Failed：执行失败，所有云主机文件下发全部执行失败 |
Running | |
| invokedID | String | 命令执行ID | a6a08d82- 2f89-11ee-a2b7-774dd7c6ebaf | |
| fileName | String | 文件名称，长度不超过128个字符 | testFile.txt | |
| description | String | 文件描述，长度不超过512个字符 | test file | |
| fileContent | String | 文件内容 | test | |
| targetDirectory | String | 下发文件的目标路径 | /home/user | |
| timeout | Integer | 下发文件的超时时间。默认值60秒 | 60 | |
| fileOwner | String | 文件所属用户，只针对linux实例，默认root | root | |
| fileGroup | String | 文件用户组，只针对linux实例，默认root | root | |
| fileMode | String | 文件权限，只针对linux实例，默认0644 | 0644 | |
| overwrite | Boolean | 是否覆盖，如果目标路径下同名文件已经存在，true：覆盖；false：不覆盖。默认false | false | |
| vmCount | Integer | 文件下发的实例数量 | 100 | |
| invokeInstances | Object | 实例列表 | invokeInstances |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|
表 invokeInstances
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| createTime | String | 文件下发任务创建时间 | 2024-07-22T09:15:55Z | |
| updateTime | String | 文件下发任务完成时间 | 2024-07-22T09:15:55Z | |
| invocationStatus | String | 单台云主机的文件下发执行状态，可能值： Pending：系统正在下发文件； Running：文件下发中； Success：文件下发成功； Failed：文件下发失败； |
Running | |
| exitCode | String | 命令退出码 | 0 | |
| errorInfo | String | 错误信息 | The instance does not exists | |
| instanceID | String | 实例ID | 8d8e8888-8ed8-88b8-88cb-888f8b8cf8fa |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"invokedID": "a6a08d82-2f89-11ee-a2b7-774dd7c6ebaf",
"pageNo": 1,
"pageSize": 10
}
响应示例
{
"returnObj": {
"pageNo": 1,
"totalCount": 1,
"results": [
{
"invokedID": "ebd9b68f-6981-4723-ad65-0ec8bd60bd3c",
"targetDirectory": "/tmp",
"description": "testDescription",
"fileGroup": "root",
"fileMode": "0644",
"fileName": "test-0221-6",
"invocationRecordStatus": "Finished",
"vmCount": 1,
"timeout": 30,
"invokeInstances": [
{
"updatedTime": "2025-02-21T01:58:38+08:00",
"invocationStatus": "Success",
"instanceID": "b29d96af-1ab8-378e-a07c-98e7675473f6",
"createdTime": "2025-02-21T01:58:35+08:00",
"errorInfo": "",
"exitCode": 0
}
],
"fileOwner": "root",
"createTime": "2025-02-20T17:58:35",
"overwrite": false,
"fileContent": "echo test"
}
],
"pageSize": 10
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
请参考 状态码
错误码
请参考 错误码
