調用DescribeSendFileResults查詢云助手下發文件列表及狀態。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀?。≧ead)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ecs:DescribeSendFileResults | get | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | 否 | 說明
該參數即將下線,推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。
| 1 |
PageSize | long | 否 | 說明
該參數即將下線,推薦您使用 NextToken 與 MaxResults 完成分頁查詢操作。
| 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. | 發送請求時發生錯誤,請稍后重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-12-05 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-21 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-09-19 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-05-12 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-02-25 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |