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

作成したクラウドアシスタントコマンドを照会します。

ActionとRegionIdパラメータのみを指定すると、Alibaba Cloud ECS はデフォルトで利用可能なすべてのコマンド（ CommandId）を照会します。


Action	string	はい	このインタフェースの名前。値：DescribeCommands。
RegionId	string	はい	リージョン ID。詳細は、 DescribeRegionsを参照してください。
CommandId	string	いいえ	コマンド ID。
Type	string	いいえ	コマンドタイプ。オプションの値： RunBatScript：コマンドプロセスは、Windows インスタンス用の Bat スクリプトです。 RunPowerShellScript：コマンドプロセスは、Windows インスタンスの PowerShell スクリプトです。 RunShellScript：コマンドプロセスは、Linux インスタンスのシェルスクリプトです。
Name	string	いいえ	コマンド名、ファジー検索が一時的にサポートされていません。
Description	string	いいえ	コマンドの説明、ファジー検索が一時的にサポートされていません。
PageNumber	Integer	いいえ	現在のページ番号。開始値：1。デフォルト値：1
PageSize	Integer	いいえ	複数ページ表示の場合の 1 ページあたりの行数。最大値：50。デフォルト値：10。

レスポンスパラメータ


TotalCount	Integer	コマンドの総数
PageNumber	Integer	コマンドリストのページ番号
PageSize	Integer	1ページあたりの行数
Command	Array	コマンドデータセットの種類（CommandSetType）

CommandSetType


Command	Array	コマンドタイプ（CommandType）

CommandType


CommandId	string	コマンド ID
Name	string	コマンド名
Description	string	コマンドの説明
Type	string	コマンドタイプ
CommandContent	string	Base64 でエンコードされた形式で送信されたコマンドコンテンツ
WorkingDir	string	呼び出しパス
TimeOut	Integer	タイムアウト

例

リクエストの例

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

成功応答の例

XML形式

<DescribeCommandsResponse>
    <TotalCount>5</TotalCount>
    <Commands>
        <Command>
                <Name>Test</Name>
                <WorkingDir></WorkingDir>
                <CommandContent>ZWNobyAxMjM=</CommandContent>
                <Timeout>3600</Timeout>
                <Type>RunShellScript</Type>
                <CommandId>c-05946950bc63441dab0a72b8xxxxxxxx</CommandId>
                <Description>test</Description>
        </Command>
        <Command>
                <Name>Test1</Name>
                <WorkingDir></WorkingDir>
                <CommandContent>Y2QgL3Jvb3Q=</CommandContent>
                <Timeout>3600</Timeout>
                <Type>RunShellScript</Type>
                <CommandId>c-53253cb556d74cb7b7f7309fdxxxxxxxx</CommandId>
                <Description>test1</Description>
        </Command>
        <Command>
                <Name>Test2</Name>
                <WorkingDir></WorkingDir>
                <CommandContent>eXVtIHVwZGF0ZQ==</CommandContent>
                <Timeout>3600</Timeout>
                <Type>RunShellScript</Type>
                <CommandId>c-57881b01e5ec4403916f8685xxxxxxxx</CommandId>
                <Description>test2</Description>
        </Command>
        <Command>
                <Name>Test3</Name>
                <WorkingDir></WorkingDir>
                <CommandContent>c2VydmljZSBuZ2lueCByZWxvYWQ=</CommandContent>
                <Timeout>3600</Timeout>
                <Type>RunShellScript</Type>
                <CommandId>c-742eea007af14043b07c4978xxxxxxxx</CommandId>
                <Description>test3</Description>
        </Command>
        <Command>
                <Name>Test4</Name>
                <WorkingDir></WorkingDir>
                <CommandContent>bHM=</CommandContent>
                <Timeout>120</Timeout>
                <Type>RunShellScript</Type>
                <CommandId>c-cec3ded3bc434c22aabcfeaaxxxxxxxx</CommandId>
                <Description>test4</Description>
        </Command>
    <PageNumber>1</PageNumber>
    <RequestId>36443468-4AE5-44DB-A6FE-A528xxxxxxxx</RequestId>
    <PageSize>10</PageSize>
}

JSON形式

{
    "TotalCount": 5,
    "Commands": {
        "Command": [
            {
                "Name": "Test",
                "WorkingDir": "",
                "CommandContent": "ZWNobyAxMjM=",
                "Timeout": 3600,
                "Type": "RunShellScript",
                "CommandId": "c-05946950bc63441dab0a72b8xxxxxxxx",
                "Description": "test"
            },
            {
                "Name": "Test1",
                "WorkingDir": "",
                "CommandContent": "Y2QgL3Jvb3Q=",
                "Timeout": 3600,
                "Type": "RunShellScript",
                "CommandId": "c-53253cb556d74cb7b7f7309fxxxxxxxx",
                "Description": "test1"
            },
            {
                "Name": "Test2",
                "WorkingDir": "",
                "CommandContent": "eXVtIHVwZGF0ZQ==",
                "Timeout": 3600,
                "Type": "RunShellScript",
                "CommandId": "c-57881b01e5ec4403916f8685xxxxxxxx",
                "Description": "test2"
            },
            {
                "Name": "Test3",
                "WorkingDir": "",
                "CommandContent": "c2VydmljZSBuZ2lueCByZWxvYWQ=",
                "Timeout": 3600,
                "Type": "RunShellScript",
                "CommandId": "c-742eea007af14043b07c4978xxxxxxxx",
                "Description": "test3"
            },
            {
                "Name": "Test4",
                "WorkingDir": "",
                "CommandContent": "bHM=",
                "Timeout": 3600,
                "Type": "RunShellScript",
                "CommandId": "c-cec3ded3bc434c22aabcfeaaxxxxxxxx",
                "Description": "test4"
            },
        ]
    },
    "PageNumber": 1,
    "RequestId": "36443468-4AE5-44DB-A6FE-A528xxxxxxxx",
    "PageSize": 10
}

エラー応答の例

XML形式

<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形式

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