详情页标题前

阿里云ECS云服务器DescribeSendFileResults-云淘科技

• 阿里云服务器
详情页1

调用DescribeSendFileResults查询云助手下发文件列表及状态。

接口说明：

  • 当您下发文件后，不代表文件一定成功下发。您需要通过接口返回值查看实际下发结果，并以实际输出结果为准。
  • 您可以查询最近6周的下发记录。

调试

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

请求参数

名称

类型

是否必选

示例值

描述
Action String 是 DescribeSendFileResults

系统规定参数。取值：DescribeSendFileResults。
RegionId String 是 cn-hangzhou

ECS实例所在的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。
ResourceGroupId String 否 rg-bp67acfmxazb4p****

文件下发的资源组ID。传入该参数后，需要在下发文件时指定ResourceGroupId，支持筛选出对应的文件下发结果。
InvokeId String 否 f-hz0jdfwd9f****

执行ID。
Name String 否 test.txt

文件名称。传入该参数后，将查询该名称文件的所有的下发记录。
InstanceId String 否 i-hz0jdfwd9f****

实例ID。传入该参数后，将查询该实例所有的文件下发记录。
PageNumber Long 否 1

当前页码。

起始值为1。

默认值为1。
PageSize Long 否 10

分页查询时设置的每页行数。

最大值为50。

默认值为10。
InvocationStatus String 否 Success

文件的总下发状态。总状态取决于本次下发的全部实例的共同执行状态，取值范围：

  • Pending：系统正在校验或下发文件。存在至少一台实例的文件下发状态为Pending，则总执行状态为Pending。
  • Running：正在实例上下发文件。存在至少一台实例的文件下发状态为Running，则总执行状态为Running。
  • Success：下发成功。各个实例上的文件下发状态均为Success，则总执行状态为Success。
  • Failed：下发失败。各个实例上的文件下发状态均为Failed，则总执行状态为Failed。
  • PartialFailed：部分实例文件下发成功且部分实例下发失败。各个实例的文件下发状态均为Success或Failed，则总执行状态为PartialFailed。
Tag.N.Key String 否 TestKey

文件下发的标签键。N的取值范围为1~20。一旦传入该值，则不允许为空字符串。

使用一个标签过滤资源，查询到该标签下的资源数量不能超过1000个。使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个，您需要使用ListTagResources接口进行查询。

最多支持64个字符，不能以aliyun或acs:开头，不能包含http://或https://。
Tag.N.Value String 否 TestValue

文件下发的标签值。N的取值范围为1~20。该值可以为空字符串。

最多支持128个字符，不能包含http://或https://。

返回数据

名称

类型

示例值

描述
PageSize Long 10

每页行数。
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。
PageNumber Long 1

查询结果的当前页码。
TotalCount Long 2

脚本总个数。
Invocations Array of Invocation

文件下发记录。
Invocation
CreationTime String 2019-12-20T06:15:54Z

文件下发任务创建时间。
InvocationStatus String Success

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

  • Pending：系统正在校验或下发文件。存在至少一台实例的文件下发状态为Pending，则总执行状态为Pending。
  • Running：正在实例上下发文件。存在至少一台实例的文件下发状态为Running，则总执行状态为Running。
  • Success：各个实例上的文件下发状态均为Success，则总执行状态为Success。
  • Failed：各个实例上的文件下发状态均为Failed，则总执行状态为Failed。实例上的文件下发状态一项或多项为以下状态时，返回值均为Failed状态：
    • 指定文件参数有误，校验失败（Invalid）。
    • 向实例下发文件失败（Aborted）。
    • 文件在实例内创建失败（Failed）。
    • 下发文件超时（Timeout）。
    • 下发文件时发生异常无法继续（Error）。
  • PartialFailed：部分实例文件下发成功且部分实例下发失败。各个实例的文件下发状态均为Success或Failed，则总执行状态为PartialFailed。
ContentType String PlainText

文件内容类型。可能值：

  • PlainText：普通文本。
  • Base64：Base64编码。
TargetDir String /home/user

目标路径。
FileOwner String test

文件的用户。
Description String This is a test file.

描述信息。
VmCount Integer 1

下发实例的数量。
FileMode String 777

文件的权限。
FileGroup String test

文件的用户组。
InvokeId String f-hz0jdfwd9f****

执行ID。
Name String test.txt

文件名称。
Content String #!/bin/bash echo “Current User is :” echo $(ps | grep “$$” | awk ‘{print $2}’)

文件内容。
Overwrite String false

是否允许覆盖。
InvokeInstances Array of InvokeInstance

下发文件目标实例集类型。
InvokeInstance
CreationTime String 2019-12-20T06:15:54Z

文件下发任务的创建时间。
StartTime String 2019-12-20T06:15:54Z

下发任务在实例中开始执行的时间。
InvocationStatus String Success

单台实例下发任务的状态，可能值：

  • Pending：系统正在校验或下发文件。
  • Invalid：指定文件参数有误，校验失败。
  • Running：正在实例上下发文件。
  • Aborted：向实例下发文件失败。
  • Success：文件下发完成。
  • Failed：文件在实例内创建失败。
  • Error：下发文件时发生异常无法继续。
  • Timeout：下发文件超时。
FinishTime String 2019-12-20T06:15:54Z

下发任务的结束时间。
UpdateTime String 2019-12-20T06:15:54Z

任务状态的更新时间。
ErrorInfo String the instance is not running when create task

文件下发的失败或执行失败原因详情。可能值：

  • 空：文件下发正常。
  • the specified instance does not exists：指定的实例不存在或已释放。
  • the specified instance has been released.：下发文件期间，该实例被释放。
  • the instance is not running when create task：创建下发文件任务时，该实例不在运行中。
  • the specified account does not exists：指定的账号不存在。
  • 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 instance is upgrading now：云助手Agent正在升级中。
  • the aliyun service in the instance need upgrade：云助手Agent需要升级。
  • the command delivery has been timeout：下发文件超时。
  • the file creation is failed due to unknown error：文件创建失败。
  • the authority of file is invalid：文件权限不合法。
  • File content is empty：文件内容为空。
  • the content of file is invalid：文件内容不合法。
  • File already exists：相同路径下存在同名文件。
  • File name is invalid：文件名不合法。
  • File path is invalid：文件路径不合法。
  • Owner not exists：用户不存在。
  • Group not exists：用户组不存在。
  • Mode is invalid：文件权限设置不合法。
ErrorCode String InstanceNotExists

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

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

实例ID。
Tags Array of Tag

文件下发的标签信息。
Tag
TagKey String owner

文件下发的标签键。
TagValue String zhangsan

文件下发的标签值。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeSendFileResults
&RegionId=cn-hangzhou
&InvokeId=f-hz0vk9****
&Name=test.txt
&InstanceId=i-bp1hsglsw****
&PageNumber=1
&PageSize=10
&

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml


    1
    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    10
    1
    
        
            0644
            false
            Success
            This is a test file.
            PlainText
            1
            /home/user
            test
            test
            
                
                    Success
                    2020-09-11T08:30:55Z
                    i-bp1hsglsw****
                    
                    2020-09-11T08:30:55Z
                    2020-09-11T08:30:55Z
                    2020-09-11T08:30:55Z
                    
                
            
            test.txt
            ZWNobyBoZWxsbw==
            2020-09-11T08:30:55Z
            f-hz0vk9****

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Invocations" : {
    "Invocation" : [ {
      "FileMode" : "0644",
      "Overwrite" : false,
      "InvocationStatus" : "Success",
      "Description" : "This is a test file.",
      "ContentType" : "PlainText",
      "VmCount" : 1,
      "TargetDir" : "/home/user",
      "FileGroup" : "test",
      "FileOwner" : "test",
      "InvokeInstances" : {
        "InvokeInstance" : [ {
          "InvocationStatus" : "Success",
          "FinishTime" : "2020-09-11T08:30:55Z",
          "InstanceId" : "i-bp1hsglsw****",
          "ErrorInfo" : "",
          "CreationTime" : "2020-09-11T08:30:55Z",
          "StartTime" : "2020-09-11T08:30:55Z",
          "UpdateTime" : "2020-09-11T08:30:55Z",
          "ErrorCode" : ""
        } ]
      },
      "Name" : "test.txt",
      "Content" : "ZWNobyBoZWxsbw==",
      "CreationTime" : "2020-09-11T08:30:55Z",
      "InvokeId" : "f-hz0vk9****"
    } ]
  }
}

错误码

HttpCode

错误码

错误信息

描述
400 RegionId.ApiNotSupported The api is not supported in this region. 指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。
400 MissingParameter.TagKey You must specify Tag.N.Key. 请指定标签键。
400 Duplicate.TagKey The Tag.N.Key contain duplicate key. 标签中存在重复的键，请保持键的唯一性。
400 InvalidTagKey.Malformed The specified Tag.n.Key is not valid. 指定的标签键参数有误。
400 InvalidTagValue.Malformed The specified Tag.n.Value is not valid. 指定的标签值参数有误。
400 InvalidParam.PageNumber The specified parameter is invalid. 指定的 PageNumber 参数无效。
400 InvalidParam.PageSize The specified parameter is invalid. 指定的 PageSize 参数无效。
403 Operation.Forbidden The operation is not permitted. 该操作是不被允许的。
500 InternalError.Dispatch An error occurred when you dispatched the request. 发送请求时发生错误，请稍后重试。

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

腾讯云1折，限时活动，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利。同意关联立享优惠

转转请注明出处：https://www.yunxiaoer.com/152754.html

赞 (0)
0
上一篇 2023年12月9日
下一篇 2023年12月9日
详情页2

相关推荐

  • 阿里云对象存储OSSPHP分片上传-云淘科技

    OSS提供的分片上传（Multipart Upload）功能，将要上传的较大文件（Object）分成多个分片（Part）来分别上传，上传完成后再调用CompleteMultipartUpload接口将这些Part组合成一个Object来达到断点续传的效果。 分片上传流程 分片上传（Multipart Upload）分为以下三个步骤： 初始化一个分片上传事件。…

    阿里云对象存储 2023年12月10日

  • 阿里云日志服务SLS关联MySQL数据源-云淘科技

    本文介绍如何创建外部存储，建立日志服务与MySQL数据库的关联。 前提条件 已采集数据到日志服务。具体操作，请参见数据采集。 已存储数据到MySQL数据库。 背景信息 日志服务外部存储功能支持日志服务与阿里云RDS MySQL数据库、在阿里云ECS上自建的MySQL数据库关联，您还可以将查询分析结果写入MySQL数据库中，便于进一步处理结果。创建外部MySQ…

    阿里云日志服务SLS 2023年12月10日

  • 阿里云ECS云服务器CreateDisk-云淘科技

    调用CreateDisk创建一块按量付费或包年包月数据盘。 接口说明 创建云盘时支持开启多重挂载特性（MultiAttach）。建议您先了解该特性及使用限制，更多信息，请参见ESSD云盘支持NVMe以及使用多重挂载功能。 支持创建的云盘类型：普通云盘、高效云盘、SSD云盘、ESSD云盘和ESSD AutoPL云盘。 创建云盘需要通过实名认证。请前往会员信息中…

    阿里云服务器 2023年12月9日

  • 阿里云ECS云服务器ResizeDisk-云淘科技

    调用ResizeDisk扩容一块云盘，支持扩容系统盘和数据盘。 接口说明 说明 扩容前，请务必查询云盘采用的分区格式。如果是MBR格式，不支持扩容到2TiB以上，否则会造成数据丢失。对于MBR分区扩容，建议您重新创建并挂载一块数据盘，采用GPT分区格式后，再将已有数据拷贝至新的数据盘上。更多详情，请参见扩容云盘容量。 支持扩容的云盘类型包括普通云盘（clou…

    阿里云服务器 2023年12月9日
  • 信息流广告，信息流部分建议宽度830px，只针对默认列表样式，顺序随机

  • 阿里云负载均衡CreateLoadBalancerUDPListener – 创建UDP监听-云淘科技

    创建UDP监听。 接口说明 经典网络的负载均衡的UDP协议监听暂不支持查看源地址。 说明 新建的监听的状态为stopped。创建完成后，调用StartLoadBalancerListener接口启动监听来转发流量。调试您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK…

    阿里云负载均衡 2023年12月10日

联系我们

400-800-8888

在线咨询： QQ交谈

邮件：admin@example.com

工作时间：周一至周五，9:30-18:30，节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买，续费优惠，保证底价，买贵退差。