调用DescribeSendFileResults查询云助手下发文件列表及状态。
接口说明:
- 当您下发文件后,不代表文件一定成功下发。您需要通过接口返回值查看实际下发结果,并以实际输出结果为准。
- 您可以查询最近 6 周的下发记录。
- 支持以下两种方式查看返回数据:
- 方式一:分页查询首页时,仅需设置
MaxResults
以限制返回信息的条目数,返回结果中的NextToken
将作为查询后续页的凭证。查询后续页时,将NextToken
参数设置为上一次返回结果中获取到的NextToken
作为查询凭证,并设置MaxResults
限制返回条目数。 - 方式二:通过
PageSize
设置单页返回的条目数,再通过PageNumber
设置页码。以上两种方式只能任选其中之一。如果设置了MaxResults
或NextToken
参数,则请求参数PageSize
和PageNumber
将失效,且返回数据中的TotalCount
无效。
- 方式一:分页查询首页时,仅需设置
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ecs:DescribeSendFileResults | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | ECS 实例所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 | cn-hangzhou |
ResourceGroupId | string | 否 | 文件下发的资源组 ID。传入该参数后,需要在下发文件时指定 ResourceGroupId,支持筛选出对应的文件下发结果。 | rg-bp67acfmxazb4p**** |
InvokeId | string | 否 | 执行 ID。 | f-hz0jdfwd9f**** |
Name | string | 否 | 文件名称。传入该参数后,将查询该名称文件的所有的下发记录。 | test.txt |
InstanceId | string | 否 | 实例 ID。传入该参数后,将查询该实例所有的文件下发记录。 | i-hz0jdfwd9f**** |
PageNumber | long | 否 | 当前页码。 起始值为 1。 默认值为 1。 | 1 |
PageSize | long | 否 | 分页查询时设置的每页行数。 最大值为 50。 默认值为 10。 | 10 |
MaxResults | integer | 否 | 分页查询时每页的最大条目数。 最大值为 50。 默认值为 10。 | 10 |
NextToken | string | 否 | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 | AAAAAdDWBF2 |
InvocationStatus | string | 否 | 文件的总下发状态。总状态取决于本次下发的全部实例的共同执行状态,取值范围:
| Success |
Tag | array<object> | 否 | 标签列表。 | |
object | 否 | 标签列表。 | ||
Key | string | 否 | 文件下发的标签键。N 的取值范围为 1~20。一旦传入该值,则不允许为空字符串。 使用一个标签过滤资源,查询到该标签下的资源数量不能超过 1000 个。使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过 1000 个。如果资源数量超过 1000 个,您需要使用 ListTagResources 接口进行查询。 最多支持 64 个字符,不能以 | TestKey |
Value | string | 否 | 文件下发的标签值。N 的取值范围为 1~20。该值可以为空字符串。 最多支持 128 个字符,不能包含 | TestValue |
返回参数
示例
正常返回示例
JSON
格式
{
"PageSize": 10,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 2,
"NextToken": "AAAAAdDWBF2",
"Invocations": {
"Invocation": [
{
"CreationTime": "2019-12-20T06:15:54Z",
"InvocationStatus": "Success",
"ContentType": "PlainText",
"TargetDir": "/home/user",
"FileOwner": "test",
"Description": "This is a test file.",
"VmCount": 1,
"FileMode": "777",
"FileGroup": "test",
"InvokeId": "f-hz0jdfwd9f****",
"Name": "test.txt",
"Content": "#!/bin/bash echo \"Current User is :\" echo $(ps | grep \"$$\" | awk '{print $2}')",
"Overwrite": "false",
"InvokeInstances": {
"InvokeInstance": [
{
"CreationTime": "2019-12-20T06:15:54Z",
"StartTime": "2019-12-20T06:15:54Z",
"InvocationStatus": "Success",
"FinishTime": "2019-12-20T06:15:54Z",
"UpdateTime": "2019-12-20T06:15:54Z",
"ErrorInfo": "the instance is not running when create task",
"ErrorCode": "InstanceNotExists",
"InstanceId": "i-uf614fhehhz****"
}
]
},
"Tags": {
"Tag": [
{
"TagKey": "owner",
"TagValue": "zhangsan"
}
]
}
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | RegionId.ApiNotSupported | The api is not supported in this region. | 指定地域下不支持调用 API。请检查 RegionId 参数取值是否正确。 |
400 | NumberExceed.Tags | The Tags parameter number is exceed. | 标签个数超过最大限制。 |
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 参数无效。 |
400 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | 指定的参数NextToken不合法。 |
400 | InvalidParameter.MaxResults | The specified parameter MaxResults is not valid. | 指定的参数MaxResults不合法。 |
403 | Operation.Forbidden | The operation is not permitted. | 该操作是不被允许的。 |
404 | InvalidRegionId.NotFound | The RegionId provided does not exist in our records. | 提供的RegionId不存在 |
500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 发送请求时发生错误,请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-12-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-09-19 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
2022-02-25 | OpenAPI 错误码发生变更 | 查看变更详情 |