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

手動で作成したクラウドアシスタントコマンド、または Alibaba Cloud が提供するパブリックコマンドを照会します。

操作説明

スクリプト操作の説明

他のリクエストパラメーターを指定せずに Action パラメーターと RegionId パラメーターのみを指定した場合、デフォルトで手動で作成された利用可能なすべてのコマンド (CommandId) が照会されます。
結果の最初のページをページングクエリする場合、返されるエントリ数を制限するために 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:DescribeCommands

get

Command。

acs:ecs:{#regionId}:{#accountId}:command/*

Command。

acs:ecs:{#regionId}:{#accountId}:command/{#commandId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
Provider	string	任意	パブリックコマンドのプロバイダー。このパラメーターの有効な値を次のリストに示します。このパラメーターを指定しない場合、デフォルトで手動で作成したすべてのクラウドアシスタントコマンドが照会されます。このパラメーターを `AlibabaCloud` に設定すると、Alibaba Cloud が提供するすべてのパブリックコマンドが照会されます。このパラメーターを特定のパブリックコマンドプロバイダーに設定すると、そのプロバイダーが提供するすべてのパブリックコマンドが照会されます。例: `Provider=AlibabaCloud.ECS.GuestOS` に設定すると、`AlibabaCloud.ECS.GuestOS` が提供するすべてのパブリックコマンドが照会されます。 `Provider=AlibabaCloud.ECS.GuestOSDiagnose` に設定すると、`AlibabaCloud.ECS.GuestOSDiagnose` が提供するすべてのパブリックコマンドが照会されます。	AlibabaCloud
CommandId	string	任意	コマンド ID。	c-hz01272yr52****
Name	string	任意	コマンドの名前。 `Provider` パラメーターを指定してパブリックコマンドをパラメータークエリする場合、デフォルトであいまい検索がサポートされます。 `Provider` パラメーターを指定せずに非公開コマンドをパラメータークエリする場合、あいまい検索がサポートされます。たとえば、`command` と入力すると名前が `command` で始まるすべてのコマンドを検索し、`command` と入力すると名前が `command` で終わるすべてのコマンドを検索し、`command` と入力すると名前に `command` を含むすべてのコマンドを検索します。	testName
Description	string	任意	コマンドスクリプトの説明。 `Provider` パラメーターを指定してパブリックコマンドをパラメータークエリする場合、デフォルトであいまい検索がサポートされます。 `Provider` パラメーターを指定せずに非公開コマンドをパラメータークエリする場合、あいまい検索がサポートされます。たとえば、`test` と入力すると説明が `test` で始まるすべてのコマンドを検索し、`test` と入力すると説明が `test` で終わるすべてのコマンドを検索し、`test` と入力すると説明に `test` を含むすべてのコマンドを検索します。	テストスクリプトの説明
Type	string	任意	コマンドのタイプ。有効な値: RunBatScript: Windows インスタンスで実行される Bat スクリプト。 RunPowerShellScript: Windows インスタンスで実行される PowerShell スクリプト。 RunShellScript: Linux インスタンスで実行されるシェルスクリプト。	RunShellScript
ContentEncoding	string	任意	応答内の CommandContent フィールドおよび Output フィールドのエンコーディングモード。有効な値: PlainText: 元のスクリプト内容と出力を返します。 Base64: Base64 エンコードされたスクリプト内容と出力を返します。デフォルト値: Base64。	PlainText
PageNumber	integer	任意	説明このパラメーターはまもなく非推奨になります。ページング操作を実行するには、NextToken と MaxResults を使用します。	1
PageSize	integer	任意	説明このパラメーターはまもなく非推奨になります。ページング操作を実行するには、NextToken と MaxResults を使用します。	10
MaxResults	integer	任意	ページング用の 1 ページあたりの最大エントリ数。最大値: 50。デフォルト値: 10。	10
NextToken	string	任意	ページネーショントークン。このパラメーターを、前の API 呼び出しで返された NextToken 値に設定します。	AAAAAdDWBF2
Latest	boolean	任意	クエリ結果にパブリックコマンドが含まれる場合に、パブリックコマンドの最新バージョンのみを照会するかどうかを指定します。このパラメーターは、非公開コマンドの照会には影響しません。 true: パブリックコマンドの最新バージョンのみを照会します。 false: パブリックコマンドのすべてのバージョンを照会します。デフォルト値: false。	true
ResourceGroupId	string	任意	コマンドが属するリソースグループの ID。	rg-123******
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
Commands	object
Command	array<object>	コマンドデータセット。
	array<object>	コマンドオブジェクト。
Category	string	パブリックコマンドのカテゴリ。	“”
CommandContent	string	コマンド内容。Base64 エンコーディングで送信されます。 ContentEncoding が PlainText に設定されている場合、元のスクリプト内容が返されます。 ContentEncoding が Base64 に設定されている場合、Base64 エンコードされたスクリプト内容が返されます。	Y2QgL3Jvb3Q=
CommandId	string	コマンド ID。	c-hz01272yr52****
CreationTime	string	コマンドが作成された時間。時間は ISO 8601 標準に従い、協定世界時 (UTC) で表されます。	2020-11-17T06:52Z
Description	string	コマンドスクリプトの説明。	テストスクリプトの説明
EnableParameter	boolean	コマンドに対してカスタムパラメーターが有効になっているかどうかを示します。	true
InvokeTimes	integer	コマンドを使用して作成されたタスクの数。	2
Latest	boolean	パブリックコマンドが最新バージョンであるかどうかを示します。複数のコマンドが同じ `Provider` に属し、同じ名前とカテゴリを持つ場合、これらのコマンドは同じコマンドの異なるバージョンです。この値は、手動で作成したクラウドアシスタントコマンドに対しては返されません。	true
Launcher	string	スクリプト実行用のブートストラッププログラム。値の長さは 1 KB を超えることはできません。	python3 -u {{ACS::ScriptFileName\|Ext(".py")}}
Name	string	コマンドの名前。	testName
ParameterDefinitions	object
ParameterDefinition	array<object>	カスタムパラメーターの詳細のリスト。
	array<object>	カスタムパラメーターオブジェクト。
DefaultValue	string	カスタムパラメーターのデフォルト値。	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm
Description	string	スクリプトのカスタムパラメーターの説明。	クラウドアシスタントエージェントのインストールパッケージのパス
ParameterName	string	カスタムパラメーターの名前。	DownloadUrl
PatternRegex	string	カスタムパラメーターの正規表現ルール。	^[a-zA-Z0-9_-]{4,32}$
PossibleValues	object
PossibleValue	array	列挙型カスタムパラメーターの有効な値のリスト。
	string	列挙型カスタムパラメーターの有効な値。	"Linux","Windows"
Required	boolean	カスタムパラメーターが必須かどうかを示します。 true: 必須。 false: 必須ではない。デフォルト値: false。	true
ParameterNames	object
ParameterName	array	コマンドの作成時に CommandContent から解析されたカスタムパラメーター名のリスト。値はリストとして返されます。カスタムパラメーターの特徴が使用されていない場合、空のリストが返されます。
	string	カスタムパラメーターの名前。	['パラメーター1','パラメーター2']
Provider	string	パブリックコマンドのプロバイダー。	AlibabaCloud.ECS.GuestOS
ResourceGroupId	string	コマンドが属するリソースグループの ID。	rg-123******
Tags	object
Tag	array<object>	コマンドのタグのリスト。
	object	コマンドのタグ情報オブジェクト。
TagKey	string	コマンドのタグキー。	owner
TagValue	string	コマンドのタグ値。	zhangsan
Timeout	integer	タイムアウト期間。単位: 秒。	3600
Type	string	コマンドのタイプ。	RunShellScript
Version	integer	パブリックコマンドのバージョン。複数のコマンドが同じ `Provider` に属し、同じ名前とカテゴリを持つ場合、これらのコマンドは同じコマンドの異なるバージョンです。この値は、手動で作成したクラウドアシスタントコマンドに対しては返されません。	1
WorkingDir	string	実行パス。	/home/
NextToken	string	この呼び出しで返されるページネーショントークン。	AAAAAdDWBF2
PageNumber	integer	コマンドリストのページ番号。	1
PageSize	integer	ページサイズ。	10
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
TotalCount	integer	コマンドの総数。	5

例

成功レスポンス

JSONJSON

{
  "Commands": {
    "Command": [
      {
        "Category": "“”",
        "CommandContent": "Y2QgL3Jvb3Q=",
        "CommandId": "c-hz01272yr52****",
        "CreationTime": "2020-11-17T06:52Z",
        "Description": "テストスクリプト",
        "EnableParameter": true,
        "InvokeTimes": 2,
        "Latest": true,
        "Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
        "Name": "testName",
        "ParameterDefinitions": {
          "ParameterDefinition": [
            {
              "DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
              "Description": "クラウドアシスタントエージェントインストールパッケージのパス",
              "ParameterName": "DownloadUrl",
              "PatternRegex": "^[a-zA-Z0-9_-]{4,32}$\u0000",
              "PossibleValues": {
                "PossibleValue": [
                  "\"Linux\",\"Windows\""
                ]
              },
              "Required": true
            }
          ]
        },
        "ParameterNames": {
          "ParameterName": [
            "['パラメーター1','パラメーター2']"
          ]
        },
        "Provider": "AlibabaCloud.ECS.GuestOS",
        "ResourceGroupId": "rg-123******",
        "Tags": {
          "Tag": [
            {
              "TagKey": "owner",
              "TagValue": "zhangsan"
            }
          ]
        },
        "Timeout": 3600,
        "Type": "RunShellScript",
        "Version": 1,
        "WorkingDir": "/home/"
      }
    ]
  },
  "NextToken": "AAAAAdDWBF2",
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "TotalCount": 5
}

エラーコード

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	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	MissingParameter.TagKey	You must specify Tag.N.Key.	タグキーを指定してください。
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.	リクエストの送信中にエラーが発生しました。後でもう一度お試しください。
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.
500	InternalError	The request processing has failed due to some unknown error.
403	Operation.Forbidden	The operation is not permitted.	操作は許可されていません。
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	InvalidName.LengthLimitExceeded	The length of the parameter Name exceeds the upper limit.
403	InvalidDescription.LengthLimitExceeded	The length of the parameter Description exceeds the upper limit.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	指定された RegionId は存在しません。このリージョンでプロダクトが利用可能かどうかを確認してください。
404	InvalidCommandType.NotFound	The specified parameter Type does not exist.
404	InvalidCommandId.NotFound	The specified commandId does not exist

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

変更履歴

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