DescribeSendFileResults - 查询下发文件列表及状态

更新时间:
复制 MD 格式

查询运维助手下发文件列表及状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eflo:DescribeSendFileResults

get

*Node

acs:eflo:{#regionId}:{#accountId}:node/*

请求参数

名称

类型

必填

描述

示例值

InvokeId

string

命令执行 ID。

t-bj038i0d6r8zoqo

NodeId

string

节点 ID

e01-cn-zvp2tgykr08

返回参数

名称

类型

描述

示例值

object

RequestId

string

Id of the request

4FD06DF0-9167-5C6F-A145-F30CA4A15D54

TotalCount

string

命令总个数。

1

Invocations

object

文件下发记录。

Invocation

array<object>

命令执行 ID。

array<object>

FileMode

string

文件的权限。

0644

Overwrite

boolean

如果同名文件在目标目录已存在,是否覆盖文件。

  • true:覆盖。

  • false:不覆盖。

默认值为 false。

true

InvocationStatus

string

文件的总下发状态。总状态取决于本次下发的全部实例的共同执行状态,可能值:

  • Pending:系统正在校验或下发文件。存在至少一台实例的文件下发状态为 Pending,则总执行状态为 Pending。

  • Running:正在实例上下发文件。存在至少一台实例的文件下发状态为 Running,则总执行状态为 Running。

  • Success:各个实例上的文件下发状态均为 Success,则总执行状态为 Success。

  • Failed:各个实例上的文件下发状态均为 Failed,则总执行状态为 Failed。实例上的文件下发状态一项或多项为以下状态时,返回值均为 Failed 状态:
    • 指定文件参数有误,校验失败(Invalid)。

    • 向实例下发文件失败(Aborted)。

    • 文件在实例内创建失败(Failed)。

    • 下发文件超时(Timeout)。

    • 下发文件时发生异常无法继续(Error)。

  • PartialFailed:部分实例文件下发成功且部分实例下发失败。各个实例的文件下发状态均为 Success 或 Failed,则总执行状态为 PartialFailed。

Pending

Description

string

命令描述。

描述信息。

ContentType

string

文件内容类型。

PlainText:普通文本。 Base64:Base64 编码。 默认值为 PlainText。

PlainText

NodeCount

integer

节点数量

3

TargetDir

string

目标路径。

/home/user

FileGroup

string

文件的用户组。

root

FileOwner

string

文件的用户。

root

Name

string

文件下发名称

test

Content

string

命令执行后的输出信息。

若 ContentEncoding 指定 PlainText,返回原始输出信息。 若 ContentEncoding 指定 Base64,返回 Base64 编码后的输出信息。

Base64

CreationTime

string

下发创建时间

2023-04-10T10:53:46.156+08:00

InvokeNodes

object

文件下发记录

InvokeNode

array<object>

节点文件下发记录

object

InvocationStatus

string

单台实例下发任务的状态,可能值:

  • Pending:系统正在校验或下发文件。

  • Invalid:指定文件参数有误,校验失败。

  • Running:正在实例上下发文件。

  • Aborted:向实例下发文件失败。

  • Success:文件下发完成。

  • Failed:文件在实例内创建失败。

  • Error:下发文件时发生异常无法继续。

  • Timeout:下发文件超时。

Success

FinishTime

string

结束时间,格式:"2020-05-22T17:04:18"。

2023-04-10T10:53:46.156+08:00

NodeId

string

节点 id

e01-cn-9lb3c15m81j

ErrorInfo

string

命令的下发失败或执行失败原因的详情,可能值:

  • 空:命令执行正常。

  • the specified instance does not exists:指定的实例不存在或已释放。

  • the node has released when create task:执行命令期间,该实例被释放。

  • the node is not running when create task:命令执行时,该实例不在运行中。

  • the command is not applicable:命令不适用于指定的实例。

  • the specified account does not exists:指定的账号不存在。

  • the specified directory does not exists:指定的目录不存在。

  • the cron job expression is invalid:指定的执行时间表达式不合法。

  • the aliyun service is not running on the instance:云助手 Agent 未运行。

  • the aliyun service in the instance does not response:云助手 Agent 无响应。

  • the aliyun service in the node is upgrading now:云助手 Agent 正在升级中。

  • the aliyun service in the node need upgrade:云助手 Agent 需要升级。

  • the command delivery has been timeout:发送命令超时。

  • the command execution has been timeout:命令执行超时。

  • the command execution got an exception:命令执行发生异常。

  • the command execution has been interrupted:命令执行被中断。

  • the command execution exit code is not zero:命令执行结束,退出码非 0。

  • the specified instance has been released:下发文件期间,该实例被释放。

the specified instance does not exists

CreationTime

string

文件下发任务的创建时间。

2023-02-06T07:12:50Z

StartTime

string

开始时间

2023-03-30T16:00:00Z

UpdateTime

string

更新时间

2023-03-30T16:00:00Z

ErrorCode

string

文件下发的失败原因代码。可能值:

空:文件下发正常。 NodeNotExists:指定的实例不存在或已释放。 NodeReleased:下发文件期间,该实例被释放。 NodeNotRunning:创建下发文件任务时,该实例不在运行中。 AccountNotExists:指定的账号不存在。 ClientNotRunning:云助手 Agent 未运行。 ClientNotResponse:云助手 Agent 无响应。 ClientIsUpgrading:云助手 Agent 正在升级中。 ClientNeedUpgrade:云助手 Agent 需要升级。 DeliveryTimeout:发送文件超时。 FileCreateFail:文件创建失败。 FileAlreadyExists:相同路径下存在同名文件。 FileContentInvalid:文件内容不合法。 FileNameInvalid:文件名不合法。 FilePathInvalid:文件路径不合法。 FileAuthorityInvalid:文件权限不合法。 UserGroupNotExists:发送文件时指定的用户组不存在。

AccountNotExists

示例

正常返回示例

JSON格式

{
  "RequestId": "4FD06DF0-9167-5C6F-A145-F30CA4A15D54",
  "TotalCount": "1",
  "Invocations": {
    "Invocation": [
      {
        "FileMode": "0644",
        "Overwrite": true,
        "InvocationStatus": "Pending",
        "Description": "描述信息。",
        "ContentType": "PlainText",
        "NodeCount": 3,
        "TargetDir": "\t/home/user",
        "FileGroup": "root",
        "FileOwner": "root",
        "Name": "test",
        "Content": "Base64",
        "CreationTime": "2023-04-10T10:53:46.156+08:00\n",
        "InvokeNodes": {
          "InvokeNode": [
            {
              "InvocationStatus": "Success",
              "FinishTime": "2023-04-10T10:53:46.156+08:00",
              "NodeId": "e01-cn-9lb3c15m81j",
              "ErrorInfo": "the specified instance does not exists",
              "CreationTime": "2023-02-06T07:12:50Z",
              "StartTime": "2023-03-30T16:00:00Z",
              "UpdateTime": "2023-03-30T16:00:00Z",
              "ErrorCode": "AccountNotExists"
            }
          ]
        }
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情