すべてのプロダクト
Search

このプロダクト

    Elastic Compute Service:DescribeSendFileResults

    ドキュメントセンター

    Elastic Compute Service:DescribeSendFileResults

    最終更新日:Sep 20, 2026

    クラウドアシスタントによって送信されたファイルのリストとステータスを照会します。

    操作説明

    操作の説明:

    • ファイルを送信した後、ファイルが必ずしも送信されるとは限りません。この操作の戻り値に基づいて実際の送信結果を確認する必要があります。実際の出力が優先されます。

    • 過去 1 日分の実行情報を照会できます。最大値 1,000 エントリの実行情報を保持できます。

    • 結果の最初のページをページングクエリする場合、MaxResults のみをセットして返されるエントリ数を制限します。結果で返される NextToken 値は、後続のページを照会するためのトークンとして機能します。後続のページをページングクエリする場合、NextToken を前の応答から取得した値にセットし、MaxResults をセットして返されるエントリ数を制限します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    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

    integer

    任意

    説明

    このパラメーターはまもなく非推奨になります。ページングクエリを実行するには、NextToken と MaxResults を使用します。

    1
    PageSize

    integer

    任意

    説明

    このパラメーターはまもなく非推奨になります。ページングクエリを実行するには、NextToken と MaxResults を使用します。

    10
    MaxResults

    integer

    任意

    ページングクエリの 1 ページあたりの最大エントリ数。

    最大値: 50。

    デフォルト値: 10。

    10
    NextToken

    string

    任意

    ページネーショントークン。このパラメーターを、前の API 呼び出しで返された NextToken 値に設定します。

    AAAAAdDWBF2
    InvocationStatus

    string

    任意

    ファイルの全体的な送信ステータス。全体的なステータスは、すべてのターゲットインスタンスの共通の実行ステータスに依存します。有効な値:

    • Pending: システムがファイルを検証または送信しています。少なくとも 1 つのインスタンスのファイル送信ステータスが Pending の場合、全体的なステータスは Pending になります。

    • Running: インスタンス上でファイルが送信されています。少なくとも 1 つのインスタンスのファイル送信ステータスが Running の場合、全体的なステータスは Running になります。

    • Success: ファイルが送信されました。すべてのインスタンスのファイル送信ステータスが Success の場合、全体的なステータスは Success になります。

    • Failed: ファイルの送信に失敗しました。すべてのインスタンスのファイル送信ステータスが Failed の場合、全体的なステータスは Failed になります。

    • PartialFailed: 一部のインスタンスではファイルが送信されましたが、他のインスタンスでは失敗しました。すべてのインスタンスのファイル送信ステータスが Success または Failed の場合、全体的なステータスは PartialFailed になります。

    Success
    Tag

    array<object>

    任意

    タグ。

    object

    任意

    タグ。

    Key

    string

    任意

    ファイル送信タスクのタグキー。N の有効な値: 1～20。タグキーは空の文字列にできません。

    単一のタグを使用してリソースをフィルター処理する場合、指定されたタグを持つリソース数は 1,000 を超えることはできません。複数のタグを使用してリソースをフィルター処理する場合、指定されたすべてのタグが付けられたリソースの数は 1,000 を超えることはできません。リソース数が 1,000 を超える場合は、 ListTagResources 操作を呼び出してリソースをクエリします。

    タグキーの長さは最大 64 文字で、aliyun または acs: で始めることはできません。http:// または https:// を含めることはできません。

    TestKey
    Value

    string

    任意

    ファイル送信タスクのタグ値。N の有効な値: 1～20。タグ値は空の文字列にできます。

    タグ値の長さは最大 128 文字で、http:// または https:// を含めることはできません。

    TestValue

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Invocations

    object

    Invocation

    array<object>

    ファイル送信レコード。

    array<object>

    Content

    string

    ファイルの内容。

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

    string

    ファイルのコンテンツタイプ。有効な値:

    • PlainText: プレーンテキスト。

    • Base64: Base64 エンコーディング。

    PlainText
    CreationTime

    string

    ファイル送信タスクが作成された時間。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。

    2019-12-20T06:15:54Z
    Description

    string

    説明。

    これはテストファイルです
    FileGroup

    string

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

    test
    FileMode

    string

    ファイルの権限。

    777
    FileOwner

    string

    ファイルのオーナー。

    test
    InvocationStatus

    string

    ファイルの全体的な送信ステータス。全体的なステータスは、すべてのターゲットインスタンスの共通の実行ステータスに依存します。有効な値:

    • Pending: システムがファイルを検証または送信しています。少なくとも 1 つのインスタンスのファイル送信ステータスが Pending の場合、全体的なステータスは Pending になります。

    • Running: インスタンス上でファイルが送信されています。少なくとも 1 つのインスタンスのファイル送信ステータスが Running の場合、全体的なステータスは Running になります。

    • Success: すべてのインスタンスのファイル送信ステータスが Success の場合、全体的なステータスは Success になります。

    • Failed: すべてのインスタンスのファイル送信ステータスが Failed の場合、全体的なステータスは Failed になります。インスタンスに対して次のいずれかのステータスが 1 つ以上返された場合、Failed 値が返されます:

      • 指定されたファイルパラメーターが無効で、検証に失敗した (Invalid)。

      • インスタンスへのファイルの送信に失敗した (Aborted)。

      • インスタンス上でのファイルの作成に失敗した (Failed)。

      • ファイルの送信がタイムアウトした (Timeout)。

      • ファイルの送信中に例外が発生し、タスクを続行できない (Error)。

    • PartialFailed: 一部のインスタンスではファイルが送信されましたが、他のインスタンスでは失敗しました。すべてのインスタンスのファイル送信ステータスが Success または Failed の場合、全体的なステータスは PartialFailed になります。

    Success
    InvokeId

    string

    実行 ID。

    f-hz0jdfwd9f****
    InvokeInstances

    object

    InvokeInstance

    array<object>

    ファイル送信のターゲットインスタンス。

    object

    CreationTime

    string

    ファイル送信タスクが作成された時間。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。

    2019-12-20T06:15:54Z
    ErrorCode

    string

    ファイル送信失敗のエラーコード。有効な値:

    • Empty: ファイルが送信されました。

    • InstanceNotExists: 指定されたインスタンスが存在しないか、リリースされています。

    • InstanceReleased: ファイル送信中にインスタンスがリリースされました。

    • InstanceNotRunning: ファイル送信タスクの作成時に、インスタンスが実行中状態ではありませんでした。

    • AccountNotExists: 指定されたアカウントが存在しません。

    • ClientNotRunning: クラウドアシスタントエージェントが実行されていません。

    • ClientNotResponse: クラウドアシスタントエージェントが応答していません。

    • ClientIsUpgrading: クラウドアシスタントエージェントがスペックアップ中です。

    • ClientNeedUpgrade: クラウドアシスタントエージェントをスペックアップする必要があります。

    • DeliveryTimeout: ファイルの送信がタイムアウトしました。

    • FileCreateFail: ファイルの作成に失敗しました。

    • FileAlreadyExists: 同じパスに同じ名前のファイルがすでに存在します。

    • FileContentInvalid: ファイルの内容が無効です。

    • FileNameInvalid: ファイル名が無効です。

    • FilePathInvalid: ファイルパスが無効です。

    • FileAuthorityInvalid: ファイルの権限が無効です。

    • UserGroupNotExists: ファイル送信に指定されたユーザーグループが存在しません。

    InstanceNotExists
    ErrorInfo

    string

    ファイル送信失敗または実行失敗の詳細。有効な値:

    • Empty: ファイルが送信されました。

    • 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: クラウドアシスタントエージェントが実行されていません。

    • the aliyun service in the instance does not response: クラウドアシスタントエージェントが応答していません。

    • the aliyun service in the instance is upgrading now: クラウドアシスタントエージェントがスペックアップ中です。

    • the aliyun service in the instance need upgrade: クラウドアシスタントエージェントをスペックアップする必要があります。

    • 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: ファイルの権限セットが無効です。

    the instance is not running when create task
    FinishTime

    string

    送信タスクが完了した時間。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。

    2019-12-20T06:15:54Z
    InstanceId

    string

    インスタンス ID

    i-uf614fhehhz****
    InvocationStatus

    string

    単一インスタンスでのファイル送信ステータス。有効な値:

    • Pending: システムがファイルを検証または送信しています。

    • Invalid: 指定されたファイルパラメーターが無効で、検証に失敗しました。

    • Running: インスタンス上でファイルが送信されています。

    • Aborted: インスタンスへのファイルの送信に失敗しました。

    • Success: ファイルが送信されました。

    • Failed: インスタンス上でのファイルの作成に失敗しました。

    • Error: ファイルの送信中に例外が発生し、タスクを続行できません。

    • Timeout: ファイルの送信がタイムアウトしました。

    Success
    StartTime

    string

    インスタンス上で送信タスクの実行が開始された時間。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。

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

    string

    タスクステータスが更新された時間。時間は ISO 8601 形式の協定世界時 (UTC) で表示されます。

    2019-12-20T06:15:54Z
    Name

    string

    ファイル名。

    test.txt
    Overwrite

    string

    上書きが許可されているかどうかを示します。

    false
    Tags

    object

    Tag

    array<object>

    ファイル送信タスクのタグ情報。

    object

    ファイル送信タスクのタグ情報。

    TagKey

    string

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

    owner
    TagValue

    string

    ファイル送信タスクのタグ値。

    zhangsan
    TargetDir

    string

    宛先パス。

    /home/user
    VmCount

    integer

    ターゲットインスタンスの数。

    1
    NextToken

    string

    この呼び出しで返されるページネーショントークン。

    AAAAAdDWBF2
    PageNumber

    integer

    返される結果のページ番号。

    1
    PageSize

    integer

    ページサイズ。

    10
    RequestId

    string

    リクエスト ID

    473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    TotalCount

    integer

    エントリの総数。

    2

    例

    成功レスポンス

    JSONJSON

    {
  "Invocations": {
    "Invocation": [
      {
        "Content": "#!/bin/bash  echo \"Current User is :\"  echo $(ps | grep \"$$\" | awk '{print $2}')",
        "ContentType": "PlainText",
        "CreationTime": "2019-12-20T06:15:54Z",
        "Description": "これはテストファイルです",
        "FileGroup": "test",
        "FileMode": "777",
        "FileOwner": "test",
        "InvocationStatus": "Success",
        "InvokeId": "f-hz0jdfwd9f****",
        "InvokeInstances": {
          "InvokeInstance": [
            {
              "CreationTime": "2019-12-20T06:15:54Z",
              "ErrorCode": "InstanceNotExists",
              "ErrorInfo": "the instance is not running when create task",
              "FinishTime": "2019-12-20T06:15:54Z",
              "InstanceId": "i-uf614fhehhz****",
              "InvocationStatus": "Success",
              "StartTime": "2019-12-20T06:15:54Z",
              "UpdateTime": "2019-12-20T06:15:54Z"
            }
          ]
        },
        "Name": "test.txt",
        "Overwrite": "false",
        "Tags": {
          "Tag": [
            {
              "TagKey": "オーナー",
              "TagValue": "zhangsan"
            }
          ]
        },
        "TargetDir": "/home/user",
        "VmCount": 1
      }
    ]
  },
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 2
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 RegionId.ApiNotSupported The api is not supported in this region. 指定されたリージョンでは API 呼び出しがサポートされていません。RegionId パラメーター値が正しいかどうかを確認してください。
    400 NumberExceed.Tags The Tags parameter number is exceed. タグの数が最大値を超えています。この操作では最大 20 個のタグを指定できます。
    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.
    400 InvalidParam.PageSize The specified parameter is invalid.
    400 InvalidParameter.NextToken The specified parameter NextToken is not valid.
    400 InvalidParameter.MaxResults The specified parameter MaxResults is not valid. 指定された MaxResults パラメーターは無効です。
    500 InternalError.Dispatch An error occurred when you dispatched the request. リクエストの送信中にエラーが発生しました。後でもう一度お試しください。
    403 InvalidParameterCharacter The specified parameter %s contains illegal characters.
    403 Operation.Forbidden The operation is not permitted. 操作は許可されていません。
    404 InvalidRegionId.NotFound The RegionId provided does not exist in our records. 指定された RegionId は存在しません。このリージョンでプロダクトが利用可能かどうかを確認してください。

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。