DescribeInvocations - - Alibaba Cloud ドキュメントセンター

クラウドアシスタントのコマンド呼び出しリストと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


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: コマンドプロセスは手動で停止します。

例

リクエストの例

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

成功のレスポンス例

XML format

<DescribeInvocationsResponse>
    <TotalCount>5</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <Invocations>
        <Invocation>
                <InvokeStatus>Running</InvokeStatus>
                <InvokeId>t-a8935b93739442e59ed621a6xxxxxxxx</InvokeId>
                <CommandName>Test1</CommandName>
                <CommandType>RunShellScript</CommandType>
                <Frequency>0 */20 * * * *</Frequency>
                <InvokeInstances>
                    <InvokeInstance>
                        <InstanceId>i-uf614fhehhzmxxxxxxxx</InstanceId>
                        <InstanceInvokeStatus>finished</InstanceInvokeStatus>
                    </InvokeInstance>
                    <InvokeInstance>
                        <InstanceId>i-uf64isakb713xxxxxxxx</InstanceId>
                        <InstanceInvokeStatus>running</InstanceInvokeStatus>
                    </InvokeInstance>
                </InvokeInstances>
                <Timed>True</Timed>
                <CommandId>c-e67505b2be3e477dae94c0f0xxxxxxxx</CommandId>
        </Invocation>
        <Invocation>
                <InvokeStatus>Running</InvokeStatus>
                <InvokeId>t-001937b74e2a4242891fc789xxxxxxxx</InvokeId>
                <CommandName>Test2</CommandName>
                <CommandType>RunShellScript</CommandType>
                <Frequency>0 */15 * * * *</Frequency>
                <InvokeInstances>
                    <InvokeInstance>
                        <InstanceId>i-uf614fhehhzmxxxxxxxx</InstanceId>
                        <InstanceInvokeStatus>finished</InstanceInvokeStatus>
                    </InvokeInstance>
                    <InvokeInstance>
                        <InstanceId>i-uf64isakb713xxxxxxxx</InstanceId>
                        <InstanceInvokeStatus>Running</InstanceInvokeStatus>
                    </InvokeInstance>
                </InvokeInstances>
                <Timed>True</Timed>
                <CommandId>c-6b0fb9d72adc421abab462abxxxxxxxx</CommandId>
        </Invocation>
        <Invocation>
                <InvokeStatus>success</InvokeStatus>
                <InvokeId>t-bd09beef975b4e50883e5df1xxxxxxxx</InvokeId>
                <CommandName>Test3</CommandName>
                <CommandType>RunShellScript</CommandType>
                <Frequency> </Frequency>
                <InvokeInstances>
                    <InvokeInstance>
                        <InstanceId>i-uf614fhehhzmxxxxxxxx</InstanceId>
                        <InstanceInvokeStatus>finished</InstanceInvokeStatus>
                    </InvokeInstance>
                    <InvokeInstance>
                        <InstanceId>i-uf64isakb713xxxxxxxx</InstanceId>
                        <InstanceInvokeStatus>finished</InstanceInvokeStatus>
                    </InvokeInstance>
                </InvokeInstances>
                <Timed>false</Timed>
                <CommandId>c-6b0fb9d72adc421abab462abxxxxxxxx</CommandId>
        </Invocation>
        <Invocation>
                <InvokeStatus>Success</InvokeStatus>
                <InvokeId>t-c7499dfdfdb44e8aa0acce5bxxxxxxxx</InvokeId>
                <CommandName>test</CommandName>
                <CommandType>RunShellScript</CommandType>
                <Frequency> </Frequency>
                <InvokeInstances>
                    <InvokeInstance>
                        <InstanceId>i-uf614fhehhzmxxxxxxxx</InstanceId>
                        <InstanceInvokeStatus>finished</InstanceInvokeStatus>
                    </InvokeInstance>
                </InvokeInstances>
                <Timed>false</Timed>
                <CommandId>c-d2a8ccf6440641ec8635f194xxxxxxxx</CommandId>
        </Invocation>
        <Invocation>
                <InvokeStatus>Running</InvokeStatus>
                <InvokeId>t-e733d4172fee452c98106f58xxxxxxxx</InvokeId>
                <CommandName>Test4</CommandName>
                <CommandType>RunBatScript</CommandType>
                <Frequency> </Frequency>
                <InvokeInstances>
                    <InvokeInstance>
                        <InstanceId>i-uf614fhehhzmxxxxxxxx</InstanceId>
                        <InstanceInvokeStatus>running</InstanceInvokeStatus>
                    </InvokeInstance>
                </InvokeInstances>
                <Timed>false</Timed>
                <CommandId>c-3f0e5e4a21c045afa197e036xxxxxxxx</CommandId>
        </Invocation>
    </Invocations>
    <RequestId>12E7974A-5AA5-4933-A44C-A16Cxxxxxxxx</RequestId>
</DescribeInvocationsResponse>

JSON format

{
    "TotalCount": 5,
    "PageNumber": 1,
    "PageSize": 10,
    "Invocations": {
        "Invocation": [
            {
                "InvokeStatus": "Running",
                "InvokeId": "t-a8935b93739442e59ed621a6xxxxxxxx",
                "CommandName": "Test1",
                "CommandType": "RunShellScript",
                "Frequency": "0 */20 * * * *",
                "InvokeInstances": {
                    "InvokeInstance": [
                        {
                            "InstanceId": "i-uf614fhehhzmxxxxxxxx",
                            "InstanceInvokeStatus": "finished"
                        },
                        {
                            "InstanceId": "i-uf64isakb713xxxxxxxx",
                            "InstanceInvokeStatus": "running"
                        }
                    ]
                },
                "Timed": true,
                "CommandId": "c-e67505b2be3e477dae94c0f0xxxxxxxx"
            },
            {
                "InvokeStatus": "Running",
                "InvokeId": "t-001937b74e2a4242891fc789xxxxxxxx",
                "CommandName": "Test2",
                "CommandType": "RunShellScript",
                "Frequency": "0 */15 * * * *",
                "InvokeInstances": {
                    "InvokeInstance": [
                        {
                            "InstanceId": "i-uf614fhehhzmxxxxxxxx",
                            "InstanceInvokeStatus": "finished"
                        },
                        {
                            "InstanceId": "i-uf64isakb713xxxxxxxx",
                            "InstanceInvokeStatus": "running"
                        }
                    ]
                },
                "Timed": true,
                "CommandId": "c-6b0fb9d72adc421abab462abxxxxxxxx"
            },
            {
                "InvokeStatus": "success",
                "InvokeId": "t-bd09beef975b4e50883e5df1xxxxxxxx",
                "CommandName": "Test3",
                "CommandType": "RunShellScript",
                "Frequency": "",
                "InvokeInstances": {
                    "InvokeInstance": [
                        {
                            "InstanceId": "i-uf614fhehhzmxxxxxxxx",
                            "InstanceInvokeStatus": "finished"
                        },
                        {
                            "InstanceId": "i-uf64isakb713xxxxxxxx",
                            "InstanceInvokeStatus": "finished"
                        }
                    ]
                },
                "Timed": false,
                "CommandId": "c-6b0fb9d72adc421abab462abxxxxxxxx"
            },
            {
                "InvokeStatus": "success",
                "InvokeId": "t-c7499dfdfdb44e8aa0acce5bxxxxxxxx",
                "CommandName": "test",
                "CommandType": "RunShellScript",
                "Frequency": "",
                "InvokeInstances": {
                    "InvokeInstance": [
                        {
                            "InstanceId": "i-uf614fhehhzmxxxxxxxx",
                            "InstanceInvokeStatus": "finished"
                        }
                    ]
                },
                "Timed": false,
                "CommandId": "c-d2a8ccf6440641ec8635f194xxxxxxxx"
            },
            {
                "InvokeStatus": "Running",
                "InvokeId": "t-e733d4172fee452c98106f58xxxxxxxx",
                "CommandName": "Test4",
                "CommandType": "RunBatScript",
                "Frequency": "",
                "InvokeInstances": {
                    "InvokeInstance": [
                        {
                            "InstanceId": "i-uf614fhehhzmxxxxxxxx",
                            "InstanceInvokeStatus": "running"
                        }
                    ]
                },
                "Timed": false,
                "CommandId": "c-3f0e5e4a21c045afa197e036xxxxxxxx"
            }
        ]
    },
    "RequestId": "12E7974A-5AA5-4933-A44C-A16Cxxxxxxxx"
}

失敗のレスポンス例

XML format

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

JSON format

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

エラーコード

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


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	内部エラー。後でもう一度お試しください。