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

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

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

swas-open:CreateCommand

create

*Command

acs:swas-open:{#regionId}:{#accountId}:command/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。利用可能なリージョンを照会するには、ListRegions を呼び出します。	cn-hangzhou
Name	string	必須	コマンドの名前。すべての文字セットがサポートされています。名前は最大 128 文字です。	testName
Description	string	任意	コマンドの説明。すべての文字セットがサポートされています。説明は最大 512 文字です。	test
Type	string	必須	コマンドの言語タイプ。有効な値: RunBatScript: Windows インスタンス用の Bat コマンド。 RunPowerShellScript: Windows インスタンス用の PowerShell コマンド。 RunShellScript: Linux インスタンス用の Shell コマンド。	RunShellScript
CommandContent	string	必須	コマンドの内容。次の点に注意してください: `EnableParameter` を `true` に設定して、コマンド内容でカスタムパラメーターを有効にします。カスタムパラメーターは `{{}}` 形式で定義します。`{{}}` 内のパラメーター名の前後のスペースと改行は無視されます。最大 20 個のカスタムパラメーターを定義できます。カスタムパラメーター名には、文字、数字、ハイフン (-)、アンダースコア (_) を使用できます。名前は大文字と小文字を区別しません。単一のカスタムパラメーター名の長さは 64 バイトを超えることはできません。	ifconfig -s
WorkingDir	string	任意	ECS インスタンスでコマンドが実行されるディレクトリ。デフォルト値: Linux インスタンスの場合: `root` ユーザーのホームディレクトリ、つまり `/root` ディレクトリ。 Windows インスタンスの場合: クラウドアシスタントクライアントプロセスが配置されているディレクトリ、たとえば `C:\Windows\System32`。	/root/
Timeout	integer	任意	サーバーインスタンスでコマンドを実行するためのタイムアウト期間 (秒単位)。コマンドタスクがタイムアウトすると、クラウドアシスタントはタスクプロセスを強制的に停止します。タイムアウト期間は 10 秒から 86,400 秒 (24 時間) の間でなければなりません。デフォルト値: 60。	60
EnableParameter	boolean	任意	コマンドでカスタムパラメーターを使用するかどうかを指定します。デフォルト値: false。	false
Tag	array<object>	任意	タグ。最大 20 個のタグを追加できます。
	object	任意	タグ。
Key	string	任意	コマンドに追加するタグ N のキー。N の有効値: 1 から 20。タグキーは空の文字列にすることはできません。長さは最大 64 文字で、`aliyun` または `acs:` で始めることはできません。`http://` または `https://` を含めることはできません。	TestKey
Value	string	任意	コマンドに追加するタグ N の値。N の有効値: 1 から 20。タグ値は空の文字列にすることができます。長さは最大 64 文字で、`http://` または `https://` を含めることはできません。	TestValue
ResourceGroupId	string	任意	リソースグループの ID。	rg-aek2bti7cf7****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ。
RequestId	string	リクエスト ID。	20758A-585D-4A41-A9B2-28DA8F4****
CommandId	string	コマンド ID。	c-sh02yh0932w****

例

成功レスポンス

JSONJSON

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4****",
  "CommandId": "c-sh02yh0932w****"
}

エラーコード

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

変更履歴

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