edit-icon download-icon

DescribeCommands

最終更新日: Aug 01, 2018

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

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

リクエストパラメータ

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

レスポンスパラメータ

名前説明
TotalCountIntegerコマンドの総数
PageNumberIntegerコマンドリストのページ番号
PageSizeInteger 1ページあたりの行数
CommandArrayコマンドデータセットの種類(CommandSetType

CommandSetType

名前説明
CommandArrayコマンドタイプ(CommandType

CommandType

名前説明
CommandId stringコマンド ID
Namestringコマンド名
Descriptionstringコマンドの説明
Typestringコマンドタイプ
CommandContent string Base64 でエンコードされた形式で送信されたコマンドコンテンツ
WorkingDir string呼び出しパス
TimeOutIntegerタイムアウト

リクエストの例

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

成功応答の例

XML形式

  1. <DescribeCommandsResponse>
  2. <TotalCount>5</TotalCount>
  3. <Commands>
  4. <Command>
  5. <Name>Test</Name>
  6. <WorkingDir></WorkingDir>
  7. <CommandContent>ZWNobyAxMjM=</CommandContent>
  8. <Timeout>3600</Timeout>
  9. <Type>RunShellScript</Type>
  10. <CommandId>c-05946950bc63441dab0a72b8xxxxxxxx</CommandId>
  11. <Description>test</Description>
  12. </Command>
  13. <Command>
  14. <Name>Test1</Name>
  15. <WorkingDir></WorkingDir>
  16. <CommandContent>Y2QgL3Jvb3Q=</CommandContent>
  17. <Timeout>3600</Timeout>
  18. <Type>RunShellScript</Type>
  19. <CommandId>c-53253cb556d74cb7b7f7309fdxxxxxxxx</CommandId>
  20. <Description>test1</Description>
  21. </Command>
  22. <Command>
  23. <Name>Test2</Name>
  24. <WorkingDir></WorkingDir>
  25. <CommandContent>eXVtIHVwZGF0ZQ==</CommandContent>
  26. <Timeout>3600</Timeout>
  27. <Type>RunShellScript</Type>
  28. <CommandId>c-57881b01e5ec4403916f8685xxxxxxxx</CommandId>
  29. <Description>test2</Description>
  30. </Command>
  31. <Command>
  32. <Name>Test3</Name>
  33. <WorkingDir></WorkingDir>
  34. <CommandContent>c2VydmljZSBuZ2lueCByZWxvYWQ=</CommandContent>
  35. <Timeout>3600</Timeout>
  36. <Type>RunShellScript</Type>
  37. <CommandId>c-742eea007af14043b07c4978xxxxxxxx</CommandId>
  38. <Description>test3</Description>
  39. </Command>
  40. <Command>
  41. <Name>Test4</Name>
  42. <WorkingDir></WorkingDir>
  43. <CommandContent>bHM=</CommandContent>
  44. <Timeout>120</Timeout>
  45. <Type>RunShellScript</Type>
  46. <CommandId>c-cec3ded3bc434c22aabcfeaaxxxxxxxx</CommandId>
  47. <Description>test4</Description>
  48. </Command>
  49. <PageNumber>1</PageNumber>
  50. <RequestId>36443468-4AE5-44DB-A6FE-A528xxxxxxxx</RequestId>
  51. <PageSize>10</PageSize>
  52. }

JSON形式

  1. {
  2. "TotalCount": 5,
  3. "Commands": {
  4. "Command": [
  5. {
  6. "Name": "Test",
  7. "WorkingDir": "",
  8. "CommandContent": "ZWNobyAxMjM=",
  9. "Timeout": 3600,
  10. "Type": "RunShellScript",
  11. "CommandId": "c-05946950bc63441dab0a72b8xxxxxxxx",
  12. "Description": "test"
  13. },
  14. {
  15. "Name": "Test1",
  16. "WorkingDir": "",
  17. "CommandContent": "Y2QgL3Jvb3Q=",
  18. "Timeout": 3600,
  19. "Type": "RunShellScript",
  20. "CommandId": "c-53253cb556d74cb7b7f7309fxxxxxxxx",
  21. "Description": "test1"
  22. },
  23. {
  24. "Name": "Test2",
  25. "WorkingDir": "",
  26. "CommandContent": "eXVtIHVwZGF0ZQ==",
  27. "Timeout": 3600,
  28. "Type": "RunShellScript",
  29. "CommandId": "c-57881b01e5ec4403916f8685xxxxxxxx",
  30. "Description": "test2"
  31. },
  32. {
  33. "Name": "Test3",
  34. "WorkingDir": "",
  35. "CommandContent": "c2VydmljZSBuZ2lueCByZWxvYWQ=",
  36. "Timeout": 3600,
  37. "Type": "RunShellScript",
  38. "CommandId": "c-742eea007af14043b07c4978xxxxxxxx",
  39. "Description": "test3"
  40. },
  41. {
  42. "Name": "Test4",
  43. "WorkingDir": "",
  44. "CommandContent": "bHM=",
  45. "Timeout": 3600,
  46. "Type": "RunShellScript",
  47. "CommandId": "c-cec3ded3bc434c22aabcfeaaxxxxxxxx",
  48. "Description": "test4"
  49. },
  50. ]
  51. },
  52. "PageNumber": 1,
  53. "RequestId": "36443468-4AE5-44DB-A6FE-A528xxxxxxxx",
  54. "PageSize": 10
  55. }

エラー応答の例

XML形式

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

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