作成したコマンド、または Alibaba Cloud が提供する共通コマンドを照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
swas-open:DescribeCommands |
get |
*Command
*Command
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
リージョン ID。 |
cn-hangzhou |
| CommandId |
string |
任意 |
コマンド ID。 |
c-sh02yh0932w**** |
| Name |
string |
任意 |
コマンド名。あいまい一致はサポートされていません。 |
testName |
| Provider |
string |
必須 |
共通コマンドのプロバイダー。次の項目に注意してください：
|
AlibabaCloud |
| Type |
string |
任意 |
コマンドの言語タイプ。有効な値：
|
RunShellScript |
| PageNumber |
string |
任意 |
ページ番号。 ページは 1 から始まります。 デフォルト値：1。 |
1 |
| PageSize |
string |
任意 |
1ページあたりのエントリ数。 最大値：50。 デフォルト値：10。 |
10 |
| Tag |
array<object> |
任意 |
コマンドにバインドされているタグ。 |
|
|
object |
任意 |
コマンドのタグ。 |
||
| Key |
string |
任意 |
コマンドのタグキー。タグキーの長さは 1～64 文字です。N の有効な値：1～20。 |
TestKey |
| Value |
string |
任意 |
コマンドのタグ値。タグ値の長さは最大 64 文字です。N の有効な値：1～20。 |
TestValue |
| ResourceGroupId |
string |
任意 |
リソースグループ ID。 |
rg-aek2bti7cf7**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答のスキーマ |
||
| RequestId |
string |
リクエスト ID。 |
20758A-585D-4A41-A9B2-28DA8F4F**** |
| TotalCount |
integer |
コマンドの総数。 |
10 |
| PageNumber |
integer |
ページ番号。 |
1 |
| PageSize |
integer |
1ページあたりのエントリ数。 |
10 |
| Commands |
array<object> |
照会されたコマンド。 |
|
|
array<object> |
コマンド。 |
||
| CommandId |
string |
コマンド ID。 |
c-gov1k1tqwi9**** |
| Tags |
array<object> |
コマンドにバインドされているタグ。 |
|
|
object |
コマンドのタグ。 |
||
| Key |
string |
コマンドのタグキー。 |
TestKey |
| Value |
string |
コマンドのタグ値。 |
TestValue |
| CreationTime |
string |
コマンドが作成された時間。 |
2023-01-05T06:38:53Z |
| Name |
string |
コマンドの名前。 |
testName |
| Provider |
string |
コマンドのプロバイダー。 |
User |
| Type |
string |
コマンドのタイプ。 |
RunShellScript |
| Timeout |
integer |
コマンドのタイムアウト期間。 |
60 |
| Description |
string |
コマンドの説明。 |
testDescription |
| WorkingDir |
string |
コマンドの実行パス。 |
/home |
| CommandContent |
string |
コマンドの内容。 |
cat /etc/ssh/sshd_config |
| EnableParameter |
boolean |
コマンドでカスタムパラメーター機能が有効になっているかどうかを示します。 |
false |
| ParameterNames |
array |
コマンドの作成時に指定されたコマンド内容から解析されたカスタムパラメーター名。カスタムパラメーター名はリスト形式で返されます。カスタムパラメーター機能が無効になっている場合、空のリストが返されます。 |
|
|
string |
カスタムパラメーター名。 |
parameter1 |
|
| ParameterDefinitions |
array<object> |
カスタムパラメーターの詳細。 |
|
|
object |
カスタムパラメーター。 |
||
| Required |
boolean |
カスタムパラメーターが必須かどうかを示します。有効な値：
デフォルト値：false。 |
false |
| Description |
string |
カスタムパラメーターの説明。 |
Command Assistant Agent Installation Package Path |
| DefaultValue |
string |
カスタムパラメーターのデフォルト値。 |
https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm |
| ParameterName |
string |
カスタムパラメーターの名前。 |
DownloadUrl |
| PossibleValues |
array |
カスタムパラメーターの有効な値。 |
|
|
string |
カスタムパラメーターの有効な値。 |
Linux |
|
| ResourceGroupId |
string |
リソースグループ ID。 |
rg-aek2bti7cf7**** |
例
成功レスポンス
JSONJSON
{
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
"TotalCount": 10,
"PageNumber": 1,
"PageSize": 10,
"Commands": [
{
"CommandId": "c-gov1k1tqwi9****",
"Tags": [
{
"Key": "TestKey",
"Value": "TestValue"
}
],
"CreationTime": "2023-01-05T06:38:53Z",
"Name": "testName",
"Provider": "User",
"Type": "RunShellScript",
"Timeout": 60,
"Description": "testDescription",
"WorkingDir": "/home",
"CommandContent": "cat /etc/ssh/sshd_config",
"EnableParameter": false,
"ParameterNames": [
"parameter1"
],
"ParameterDefinitions": [
{
"Required": false,
"Description": "Command Assistant Agent Installation Package Path",
"DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
"ParameterName": "DownloadUrl",
"PossibleValues": [
"Linux"
]
}
],
"ResourceGroupId": "rg-aek2bti7cf7****"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。