Cloud Assistantによって送信されたファイルとそのステータスを照会します。

説明

  • ファイルを送信すると、指定されたインスタンスにファイルが送信されない場合があります。 ファイルの送信結果を確認するには、この操作を呼び出す必要があります。
  • この操作では、過去2週間のファイル送信レコードを照会します。 最大100,000のファイル送信レコードを保持できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 DescribeSendFileResults

実行する操作です。 値をDescribeSendFileResultsに設定します。

RegionId String 必須 cn-hangzhou

インスタンスのリージョン ID です。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

InvokeId String 任意 f-hz0jdfwd9f ****

実行のID。

パラメーター名 String 任意 test.txt

送信レコードを照会するファイルの名前。

InstanceId String 任意 i-hz0jdfwd9f ****

ファイル送信結果を照会するインスタンスのID。

PageNumber Long 任意 1

返されるページ数。

ページ番号は 1 から始まります。

デフォルト値:1。

PageSize Long 任意 10

各ページで返されるエントリ数。

最大値: 50。

Default value: 10.

レスポンスパラメーター

パラメーター データ型 説明
PageSize Long 10

1 ページあたりで返されるエントリ数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

リクエストの ID です。

PageNumber Long 1

返されたページの数です。

TotalCount Long 2

ファイル送信タスクの総数。

呼び出し 呼び出しの配列

レコードを送信するファイルの詳細。

呼び出し
CreationTime String 2019-12-20T06:15:54Z

ファイル送信タスクが作成された時刻。

InvocationStatus String Success

ファイルの全体的な送信ステータス。 ファイルの全体的な送信ステータスは、すべての宛先インスタンスでの送信ステータスによって異なります。 設定可能な値は以下のとおりです。

  • 保留中: ファイルが検証または送信中です。 少なくとも1つのインスタンス上のファイルの送信ステータスがPendingの場合、ファイルの全体的な送信ステータスはPendingです。
  • 実行中: インスタンスでファイル作成タスクが実行中です。 少なくとも1つのインスタンスのファイルの送信ステータスがRunningの場合、ファイルの全体的な送信ステータスはRunningです。
  • Success: すべてのインスタンスのファイルの送信ステータスがSuccessの場合、ファイルの全体的な送信ステータスはSuccessです。
  • Failed: すべてのインスタンスのファイルの送信ステータスがFailedの場合、ファイルの全体的な送信ステータスはFailedです。 1つ以上のインスタンスのファイルの送信ステータスが次のいずれかの値の場合、ファイルの全体的な送信ステータスはFailedです。
    • Invalid: ファイルが無効です。
    • Aborted: ファイルの送信に失敗しました。
    • Failed: ファイルの作成に失敗しました。
    • Timeout: The file sending task timed out.
    • エラー: ファイルの送信中にエラーが発生しました。
  • PartialFailed: 指定されたインスタンスの一部にファイルが送信され、他のインスタンスに送信できませんでした。 ファイルの全体的な送信ステータスは、一部のインスタンスで送信ステータスがSuccess、他のインスタンスでFailedの場合にのみPartialFailedです。
ContentType String PlainText

ファイルのコンテンツタイプ。 設定可能な値は以下のとおりです。

  • PlainText
  • Base64
TargetDir String /ルート

宛先ディレクトリ。

FileOwner String root

ファイルの所有者。

説明 String これはテストファイルです。

ファイルの説明。

VmCount Integer 1

ファイルを送信するインスタンスの数。

FileMode String 777

ファイルに対する権限。

FileGroup String root

ファイルのユーザーグループ。

InvokeId String f-hz0jdfwd9f ****

The ID of the execution.

パラメーター名 String test.txt

The name of the file.

Content String #!/bin/bash echo "Current User is :" echo $(ps grep "$$" awk '{print $2}')

The content of the file.

上書き String false

宛先ディレクトリ内のファイルが、送信されたファイルと同じ名前である場合に上書きされるかどうかを示します。

InvokeInstances InvokeInstanceの配列

Details about the destination instances.

InvokeInstance
CreationTime String 2019-12-20T06:15:54Z

ファイル送信タスクの作成時刻。

StartTime String 2019-12-20T06:15:54Z

The time when the file sending task started to be executed on the instance.

InvocationStatus String Success

ファイル送信タスクのステータス。

FinishTime String 2019-12-20T06:15:54Z

ファイル送信タスクの実行が完了した時刻。

UpdateTime String 2019-12-20T06:15:54Z

タスクのステータスが更新された時刻。

エラー情報 String タスクの作成時にインスタンスが実行されていない

インスタンスへのファイルの送信に失敗した場合、またはインスタンスでのファイル送信タスクの実行に失敗した場合に返されるエラーメッセージ。 設定可能な値は以下のとおりです。

  • Null: ファイルがインスタンスに送信されます。
  • 指定されたインスタンスが存在しない
  • タスクの作成時にインスタンスがリリースされました
  • タスクの作成時にインスタンスが実行されていない
  • 指定されたアカウントが存在しない
  • インスタンスでaliyunサービスが実行されていない場合
  • インスタンスのaliyunサービスが応答しない
  • インスタンスのaliyunサービスがアップグレード中
  • インスタンスのaliyunサービスのアップグレードが必要
  • コマンド配信がタイムアウトしました
  • 作成中の予期しないエラー
  • ファイルは既に存在します
  • ファイル内容エラー
  • ファイル名が無効です
  • ファイルパスが無効です
  • 所有者が存在しない
  • グループが存在しない
  • モードが無効です
ErrorCode String InstanceNotExists

ファイルのインスタンスへの送信に失敗したときに返されるエラーコード。 設定可能な値は以下のとおりです。

  • Null: ファイルがインスタンスに送信されます。
  • InstanceNotExists: インスタンスが存在しないか、リリースされました。
  • InstanceReleased: ファイルの送信中にインスタンスがリリースされます。
  • InstanceNotRunning: ファイル送信タスクが作成されているとき、インスタンスは実行されていません。
  • AccountNotExists: 指定されたアカウントは存在しません。
  • ClientNotRunning: Cloud Assistantクライアントが実行されていません。
  • ClientNotResponse: Cloud Assistantクライアントが応答していません。
  • ClientIsUpgrading: Cloud Assistantクライアントのアップグレード中です。
  • ClientNeedUpgrade: Cloud Assistantクライアントをアップグレードする必要があります。
  • DeliveryTimeout: ファイル送信タスクがタイムアウトしました。
  • FileCreateFail: ファイルの作成に失敗しました。
  • FileAlreadyExists: 指定されたディレクトリに同じ名前のファイルが既に存在します。
  • FileContentInvalid: ファイルの内容が無効です。
  • FileNameInvalid: ファイル名が無効です。
  • FilePathInvalid: 指定されたディレクトリは無効です。
  • FileAuthorityInvalid: ファイルに対して指定された権限が無効です。
InstanceId String i-uf614fhehhz ****

インスタンスの ID。

リクエストの例

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

<DescribeSendFileResultsResponse>
    <TotalCount>1</TotalCount>
    <RequestId> 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E </ RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Invocations>
        <呼び出し>
            <FileMode>0644</FileMode>
            <上書き> false</Overwrite>
            <InvocationStatus> 成功 </InvocationStatus>
            <Description> これはテストファイルです。</Description>
            <ContentType>PlainText</ContentType>
            <VmCount>1</VmCount>
            <TargetDir>/root</TargetDir>
            <FileGroup> ルート </FileGroup>
            <FileOwner>root</FileOwner>
            <InvokeInstances>
                <InvokeInstance>
                    <InvocationStatus> 成功 </InvocationStatus>
                    <FinishTime>2020-09-11T08:30:55Z</FinishTime>
                    <InstanceId>i-bp1hsglsw ****</InstanceId>
                    <ErrorInfo/>
                    <CreationTime>2020-09-11T08:30:55Z</CreationTime>
                    <StartTime>2020-09-11T08:30:55Z</StartTime>
                    <UpdateTime>2020-09-11T08:30:55Z</UpdateTime>
                    <ErrorCode/>
                </InvokeInstance>
            </InvokeInstances>
            <名前> test.txt</名前>
            <コンテンツ> ZWNobyBoZWxsbw ==< /コンテンツ>
            <CreationTime>2020-09-11T08:30:55Z</CreationTime>
            <InvokeId>f-hz0vk9 ****</InvokeId>
        </呼び出し>
    </呼び出し>
</DescribeSendFileResultsResponse>

JSON 形式

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

{
  "TotalCount" : 1、
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E" 、
  "PageSize" : 10,
  "PageNumber" : 1,
  "呼び出し" : {
    "Invocation" : [ {
      "FileMode" : "0644" 、
      "上書き" : false、
      "InvocationStatus" : "Success" 、
      "Description" : "これはテストファイルです。
      "ContentType" : "PlainText" 、
      "VmCount" : 1、
      "TargetDir" : "/root" 、
      "FileGroup" : "root" 、
      "FileOwner" : "root" 、
      "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 ****"
    } ]
  }
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
400 RegionId.ApiNotSupported このリージョンではapiはサポートされていません。 指定されたリージョンでAPI操作を呼び出すことができない場合に返されるエラーメッセージ。 RegionIdパラメーターが有効かどうかを確認します。
403 InvalidParam.PageNumber 指定したパラメーターは無効です。 指定されたPageNumberパラメーターが無効な場合に返されるエラーメッセージ。
403 InvalidParam.PageSize 指定したパラメーターは無効です。 指定されたPageSizeパラメーターが無効な場合に返されるエラーメッセージ。
403 操作禁止 操作は許可されていません。 The error message returned because the operation is not supported.
500 InternalError.Dispatch リクエストの送信時にエラーが発生しました。 リクエストの送信時にエラーが発生した場合に返されるエラーメッセージ。 しばらくしてから再試行します。

エラーコードリストについては、「API エラーセンター」をご参照ください。