手動で作成したコマンド、または 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 |
任意 |
ページあたりのエントリ数。 最大値： 50。 デフォルト： 10。 |
10 |
| Tag |
array<object> |
任意 |
コマンドのタグ。 |
|
|
object |
任意 |
タグ。 |
||
| Key |
string |
任意 |
コマンドのタグキー。タグキーの長さは 1～64 文字です。N の有効な値： 1～20。 |
TestKey |
| Value |
string |
任意 |
コマンドのタグ値。タグ値の長さは 1～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 |
ページあたりのエントリ数。 |
10 |
| Commands |
array<object> |
コマンドのリスト。 |
|
|
array<object> |
コマンド情報の構造体。 |
||
| CommandId |
string |
コマンド ID。 |
c-gov1k1tqwi9**** |
| Tags |
array<object> |
コマンドのタグのリスト。 |
|
|
object |
タグ情報。 |
||
| Key |
string |
コマンドのタグキー。 |
TestKey |
| Value |
string |
コマンドのタグ値。 |
TestValue |
| CreationTime |
string |
コマンドが作成された時刻。 時刻は UTC (Z) で、YYYY-MM-DDThh:mm:ssZ 形式で表示されます。 |
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 |
コマンドの作成時に CommandContent から解析されたカスタムパラメーター名のリスト。 リストは List 形式で返されます。 カスタムパラメーター機能が有効でない場合、空のリストが返されます。 |
|
|
string |
カスタムパラメーター。 |
parameter1 |
|
| ParameterDefinitions |
array<object> |
カスタムパラメーターの詳細リスト。 |
|
|
object |
カスタムパラメーターの詳細構造体。 |
||
| Required |
boolean |
カスタムパラメーターが必須かどうか。 有効な値：
デフォルト値：false。 |
false |
| Description |
string |
カスタムパラメーターの説明。 |
命令助手Agent安装包路径 |
| 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": "命令助手Agent安装包路径",
"DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
"ParameterName": "DownloadUrl",
"PossibleValues": [
"Linux"
]
}
],
"ResourceGroupId": "rg-aek2bti7cf7****"
}
]
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。