edit-icon download-icon

DescribeInvocations

最終更新日: Feb 26, 2019

説明

クラウドアシスタントのコマンド呼び出しリストとECSインスタンスのステータスを照会します。

InvokeStatus値がFinishedであるとき、それはコマンド処理が Finishedであることを示しますが、必ずしも期待どおりに有効であるとは限りません。 DescribeInvocationResults を呼び出すと、特定の呼び出し結果を確認できます。

リクエストパラメータ

名前 必要かどうか 説明
Action String Yes インタフェースの名前。 値:DescribeInvocations。
RegionId String Yes リージョン ID。 詳細は、DescribeRegions をご参照してください。
InvokeId String No コマンド・プロセスの呼び出しID。
CommandId String No コマンドID。 DescribeCommandsを呼び出すことによって、利用可能なすべてのCommandIdを照会することができます。
CommandName String No コマンドの名前。
Type String No コマンドのタイプ。 オプションの値:
  • RunBatScript:Windowsインスタンス用のBatスクリプト。
  • RunPowerShellScript:Windowsインスタンス用のPowerShellスクリプト。
  • RunShellScript:Linuxインスタンス用のシェルスクリプト。
Timed Boolean No コマンドが定期的に実行されるかどうか。 オプションの値:
  • True: 定期呼び出し。
  • False: 定期的な呼び出しではありません。
デフォルト値: False.
InvokeStatus String No コマンドの全体的な呼び出し状況を指定します。 全体の呼び出し状況は、すべてのターゲット・インスタンスのコマンド・プロセスの呼び出し状況によって異なります。 オプションの値:
  • Running: コマンドプロセスが実行されています。
    • Periodical invocation: 定期的な呼び出しでコマンドを手動で停止する前に、コマンド処理は常に「実行中」の状態になります。
    • One-time invocation: コマンド・プロセスが任意のターゲット・インスタンスの「実行中」状態にある限り、全体の起動状態は「実行中」である。
  • Finished: コマンド・プロセスの呼び出しが完了しました。
    • Periodical invocation: コマンド処理は決して「終了」状態にはなりません。
    • One-time invocation: 指定されたコマンドによって管理されているすべてのターゲット・インスタンスに対するコマンド・プロセスの呼び出しが完了すると、全体の呼び出し状況は「完了」になります。
      または、いくつかのターゲットインスタンス( Stopped)でコマンドプロセスの呼び出しを手動で停止し、他のターゲットインスタンスの呼び出しが完了すると、全体的な呼び出しステータスはFinishedになります。
  • Failed: コマンド・プロセスの呼び出しが失敗しました。コマンド・プロセスのタイムアウトが発生しました。他の例外が発生しました。
    • Periodical invocation: コマンドプロセスは決して Failedステータスになることはありません。
    • One-time invocation: 指定されたコマンドによって管理されているすべてのターゲット・インスタンスに対するコマンド・プロセスの呼び出しが失敗すると、全体の呼び出し状況は「失敗」になります。
  • PartialFailed: コマンド・プロセスの呼び出しの一部が失敗しました。
    • Periodical invocation: コマンドプロセスは決してPartialFailed状態にはなりません。
    • One-time invocation: コマンドプロセスが、指定されたコマンドによって管理されているターゲットインスタンスの「失敗」ステータスにあるとき、全体的な起動ステータスは PartialFailedです。
  • Stopped: コマンドプロセスは手動で停止します。
InstanceId String No インスタンスID。 パラメーターを渡すと、システムはインスタンス上のすべてのコマンドの呼び出しレコード状況を照会します。
PageNumber Integer No 現在のページ番号。
開始値:1
デフォルト値:1
PageSize Integer No 複数ページ表示の場合の1ページあたりの行数。
最大値:50
デフォルト値:10

レスポンスパラメータ

名前 説明
TotalCount Integer コマンドの総数
PageNumber Integer クエリ結果のページ番号
PageSize Integer ページあたりの行数
Invocations Array コマンド呼び出しレコードセットのタイプ(InvocationSetType

InvocationSetType

名前 説明
Invocation Array コマンド起動タイプ(InvocationType

InvocationType

Name Type Description
InvokeId String コマンド呼び出し ID
CommandId String コマンド ID
CommandName String コマンド名
InvokeStatus String コマンドの全体的な呼び出し状況を指定します。 全体の呼び出し状況は、すべてのターゲット・インスタンスのコマンド・プロセスの呼び出し状況に依存します。 オプションの値:
  • Running: コマンドプロセスが実行されています。
    • Periodical invocation: 定期的な呼び出しでコマンドを手動で停止する前に、コマンド処理は常に「実行中」の状態になります。
    • One-time invocation: マンド・プロセスが任意のターゲット・インスタンスの「実行中」状態にある限り、全体の起動状態は「実行中」である。
  • Finished: コマンド・プロセスの呼び出しが完了しました。
    • Periodical invocation: コマンド処理は決して「終了」状態にはなりません。
    • One-time invocation: 指定されたコマンドによって管理されているすべてのターゲット・インスタンスに対するコマンド・プロセスの呼び出しが完了すると、全体の呼び出し状況は「完了」になります。
      または、いくつかのターゲットインスタンス( Stopped)でコマンドプロセスの呼び出しを手動で停止し、他のターゲットインスタンスの呼び出しが完了すると、全体的な呼び出しステータスはFinishedになります。
  • Failed: コマンド・プロセスの呼び出しが失敗しました。コマンド・プロセスのタイムアウトが発生しました。他の例外が発生しました。
    • Periodical invocation: コマンドプロセスは決して Failedステータスになることはありません。
    • One-time invocation: 指定されたコマンドによって管理されているすべてのターゲット・インスタンスに対するコマンド・プロセスの呼び出しが失敗すると、全体の呼び出し状況は「失敗」になります。
  • PartialFailed: コマンド・プロセスの呼び出しの一部が失敗しました。
    • Periodical invocation: コマンドプロセスは決してPartialFailed状態にはなりません。
    • One-time invocation: コマンドプロセスが、指定されたコマンドによって管理されているターゲットインスタンスの「失敗」ステータスにあるとき、全体的な起動ステータスは PartialFailedです。
  • Stopped: コマンドプロセスは手動で停止します。
CommandType String コマンドタイプ
Timed Boolean コマンドが定期的に実行されるかどうか。
Frequency String 定期的なタスクの間隔。 値の指定の詳細については、Cron expressionを参照してください。
InvokeInstances Array 呼び出しのために設定されたターゲットインスタンスのタイプ(InvokeInstanceSetType)

InvokeInstanceSetType

名前 説明
InvokeInstance Array ターゲットインスタンスの呼び出しステータスタイプ (InvokeInstanceType)

InvokeInstanceType

名前 タイプ 説明
InstanceId String インスタンス ID
InstanceInvokeStatus String 指定されたインスタンスのコマンド処理ステータス。
  • Running: コマンドプロセスが実行されています。
    • Periodical invocation: 定期的な呼び出しでコマンドを手動で停止する前に、コマンド処理は常に「実行中」の状態になります。
    • One-time invocation: 指定されたインスタンスのコマンド処理ステータスは「実行中」です。
  • Finished: コマンド・プロセスの呼び出しが完了しました。.
    • Periodical invocation: コマンド処理は決して「終了」状態にはなりません。
    • One-time invocation: 指定されたインスタンスのコマンド処理ステータスは Finishedです。
  • Failed: コマンド・プロセスの呼び出しが失敗しました。コマンド・プロセスのタイムアウトが発生しました。他の例外が発生しました。
    • Periodical invocation: コマンドプロセスは決して Failedステータスになることはありません。
    • One-time invocation: 指定されたインスタンスのコマンド・プロセス・ステータスはFailedです。
  • Stopped: コマンドプロセスは手動で停止します。

リクエストの例

  1. https://ecs.aliyuncs.com/?Action=DescribeInvocations
  2. &RegionId=cn-hangzhou
  3. &<Common Request Parameters>

成功のレスポンス例

XML format

  1. <DescribeInvocationsResponse>
  2. <TotalCount>5</TotalCount>
  3. <PageNumber>1</PageNumber>
  4. <PageSize>10</PageSize>
  5. <Invocations>
  6. <Invocation>
  7. <InvokeStatus>Running</InvokeStatus>
  8. <InvokeId>t-a8935b93739442e59ed621a6xxxxxxxx</InvokeId>
  9. <CommandName>Test1</CommandName>
  10. <CommandType>RunShellScript</CommandType>
  11. <Frequency>0 */20 * * * *</Frequency>
  12. <InvokeInstances>
  13. <InvokeInstance>
  14. <InstanceId>i-uf614fhehhzmxxxxxxxx</InstanceId>
  15. <InstanceInvokeStatus>finished</InstanceInvokeStatus>
  16. </InvokeInstance>
  17. <InvokeInstance>
  18. <InstanceId>i-uf64isakb713xxxxxxxx</InstanceId>
  19. <InstanceInvokeStatus>running</InstanceInvokeStatus>
  20. </InvokeInstance>
  21. </InvokeInstances>
  22. <Timed>True</Timed>
  23. <CommandId>c-e67505b2be3e477dae94c0f0xxxxxxxx</CommandId>
  24. </Invocation>
  25. <Invocation>
  26. <InvokeStatus>Running</InvokeStatus>
  27. <InvokeId>t-001937b74e2a4242891fc789xxxxxxxx</InvokeId>
  28. <CommandName>Test2</CommandName>
  29. <CommandType>RunShellScript</CommandType>
  30. <Frequency>0 */15 * * * *</Frequency>
  31. <InvokeInstances>
  32. <InvokeInstance>
  33. <InstanceId>i-uf614fhehhzmxxxxxxxx</InstanceId>
  34. <InstanceInvokeStatus>finished</InstanceInvokeStatus>
  35. </InvokeInstance>
  36. <InvokeInstance>
  37. <InstanceId>i-uf64isakb713xxxxxxxx</InstanceId>
  38. <InstanceInvokeStatus>Running</InstanceInvokeStatus>
  39. </InvokeInstance>
  40. </InvokeInstances>
  41. <Timed>True</Timed>
  42. <CommandId>c-6b0fb9d72adc421abab462abxxxxxxxx</CommandId>
  43. </Invocation>
  44. <Invocation>
  45. <InvokeStatus>success</InvokeStatus>
  46. <InvokeId>t-bd09beef975b4e50883e5df1xxxxxxxx</InvokeId>
  47. <CommandName>Test3</CommandName>
  48. <CommandType>RunShellScript</CommandType>
  49. <Frequency> </Frequency>
  50. <InvokeInstances>
  51. <InvokeInstance>
  52. <InstanceId>i-uf614fhehhzmxxxxxxxx</InstanceId>
  53. <InstanceInvokeStatus>finished</InstanceInvokeStatus>
  54. </InvokeInstance>
  55. <InvokeInstance>
  56. <InstanceId>i-uf64isakb713xxxxxxxx</InstanceId>
  57. <InstanceInvokeStatus>finished</InstanceInvokeStatus>
  58. </InvokeInstance>
  59. </InvokeInstances>
  60. <Timed>false</Timed>
  61. <CommandId>c-6b0fb9d72adc421abab462abxxxxxxxx</CommandId>
  62. </Invocation>
  63. <Invocation>
  64. <InvokeStatus>Success</InvokeStatus>
  65. <InvokeId>t-c7499dfdfdb44e8aa0acce5bxxxxxxxx</InvokeId>
  66. <CommandName>test</CommandName>
  67. <CommandType>RunShellScript</CommandType>
  68. <Frequency> </Frequency>
  69. <InvokeInstances>
  70. <InvokeInstance>
  71. <InstanceId>i-uf614fhehhzmxxxxxxxx</InstanceId>
  72. <InstanceInvokeStatus>finished</InstanceInvokeStatus>
  73. </InvokeInstance>
  74. </InvokeInstances>
  75. <Timed>false</Timed>
  76. <CommandId>c-d2a8ccf6440641ec8635f194xxxxxxxx</CommandId>
  77. </Invocation>
  78. <Invocation>
  79. <InvokeStatus>Running</InvokeStatus>
  80. <InvokeId>t-e733d4172fee452c98106f58xxxxxxxx</InvokeId>
  81. <CommandName>Test4</CommandName>
  82. <CommandType>RunBatScript</CommandType>
  83. <Frequency> </Frequency>
  84. <InvokeInstances>
  85. <InvokeInstance>
  86. <InstanceId>i-uf614fhehhzmxxxxxxxx</InstanceId>
  87. <InstanceInvokeStatus>running</InstanceInvokeStatus>
  88. </InvokeInstance>
  89. </InvokeInstances>
  90. <Timed>false</Timed>
  91. <CommandId>c-3f0e5e4a21c045afa197e036xxxxxxxx</CommandId>
  92. </Invocation>
  93. </Invocations>
  94. <RequestId>12E7974A-5AA5-4933-A44C-A16Cxxxxxxxx</RequestId>
  95. </DescribeInvocationsResponse>

JSON format

  1. {
  2. "TotalCount": 5,
  3. "PageNumber": 1,
  4. "PageSize": 10,
  5. "Invocations": {
  6. "Invocation": [
  7. {
  8. "InvokeStatus": "Running",
  9. "InvokeId": "t-a8935b93739442e59ed621a6xxxxxxxx",
  10. "CommandName": "Test1",
  11. "CommandType": "RunShellScript",
  12. "Frequency": "0 */20 * * * *",
  13. "InvokeInstances": {
  14. "InvokeInstance": [
  15. {
  16. "InstanceId": "i-uf614fhehhzmxxxxxxxx",
  17. "InstanceInvokeStatus": "finished"
  18. },
  19. {
  20. "InstanceId": "i-uf64isakb713xxxxxxxx",
  21. "InstanceInvokeStatus": "running"
  22. }
  23. ]
  24. },
  25. "Timed": true,
  26. "CommandId": "c-e67505b2be3e477dae94c0f0xxxxxxxx"
  27. },
  28. {
  29. "InvokeStatus": "Running",
  30. "InvokeId": "t-001937b74e2a4242891fc789xxxxxxxx",
  31. "CommandName": "Test2",
  32. "CommandType": "RunShellScript",
  33. "Frequency": "0 */15 * * * *",
  34. "InvokeInstances": {
  35. "InvokeInstance": [
  36. {
  37. "InstanceId": "i-uf614fhehhzmxxxxxxxx",
  38. "InstanceInvokeStatus": "finished"
  39. },
  40. {
  41. "InstanceId": "i-uf64isakb713xxxxxxxx",
  42. "InstanceInvokeStatus": "running"
  43. }
  44. ]
  45. },
  46. "Timed": true,
  47. "CommandId": "c-6b0fb9d72adc421abab462abxxxxxxxx"
  48. },
  49. {
  50. "InvokeStatus": "success",
  51. "InvokeId": "t-bd09beef975b4e50883e5df1xxxxxxxx",
  52. "CommandName": "Test3",
  53. "CommandType": "RunShellScript",
  54. "Frequency": "",
  55. "InvokeInstances": {
  56. "InvokeInstance": [
  57. {
  58. "InstanceId": "i-uf614fhehhzmxxxxxxxx",
  59. "InstanceInvokeStatus": "finished"
  60. },
  61. {
  62. "InstanceId": "i-uf64isakb713xxxxxxxx",
  63. "InstanceInvokeStatus": "finished"
  64. }
  65. ]
  66. },
  67. "Timed": false,
  68. "CommandId": "c-6b0fb9d72adc421abab462abxxxxxxxx"
  69. },
  70. {
  71. "InvokeStatus": "success",
  72. "InvokeId": "t-c7499dfdfdb44e8aa0acce5bxxxxxxxx",
  73. "CommandName": "test",
  74. "CommandType": "RunShellScript",
  75. "Frequency": "",
  76. "InvokeInstances": {
  77. "InvokeInstance": [
  78. {
  79. "InstanceId": "i-uf614fhehhzmxxxxxxxx",
  80. "InstanceInvokeStatus": "finished"
  81. }
  82. ]
  83. },
  84. "Timed": false,
  85. "CommandId": "c-d2a8ccf6440641ec8635f194xxxxxxxx"
  86. },
  87. {
  88. "InvokeStatus": "Running",
  89. "InvokeId": "t-e733d4172fee452c98106f58xxxxxxxx",
  90. "CommandName": "Test4",
  91. "CommandType": "RunBatScript",
  92. "Frequency": "",
  93. "InvokeInstances": {
  94. "InvokeInstance": [
  95. {
  96. "InstanceId": "i-uf614fhehhzmxxxxxxxx",
  97. "InstanceInvokeStatus": "running"
  98. }
  99. ]
  100. },
  101. "Timed": false,
  102. "CommandId": "c-3f0e5e4a21c045afa197e036xxxxxxxx"
  103. }
  104. ]
  105. },
  106. "RequestId": "12E7974A-5AA5-4933-A44C-A16Cxxxxxxxx"
  107. }

失敗のレスポンス例

XML format

  1. <Error>
  2. <RequestId>540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx</RequestId>
  3. <HostId>ecs.aliyuncs.com</HostId>
  4. <Code>MissingParameter.RegionId</Code>
  5. <Message>The input parameter “RegionId” that is mandatory for processing this request is not supplied.</Message>
  6. </Error>

JSON format

  1. {
  2. "RequestId": "540CFF28-407A-40B5-B6A5-74Bxxxxxxxxx",
  3. "HostId": "ecs.aliyuncs.com"
  4. "Code": "MissingParameter.RegionId"
  5. "Message": "The input parameter “RegionId” that is mandatory for processing this request is not supplied."
  6. }

エラーコード

このインタフェースに固有のエラーコードは次のとおりです。詳細については、API のエラー・センターを参照してください。

エラーコード エラーメッセッジ HTTP ステータスコード 説明
MissingParameter.RegionId The input parameter “RegionId” that is mandatory for processing this request is not supplied. 400 RegionIdの必須パラメータを指定する必要があります。指定されたリージョン内のリソースを使用することはできません。
InvalidRegionId.NotFound The RegionId provided does not exist in our items. 404 指定された RegionIdは存在しません。
InternalError.Dispatch An internal error occurred when dispath the request 500 内部エラー。 後でもう一度お試しください。