调用DescribeCommands查询您已经创建的云助手命令。只输入参数Action和RegionId,不输入其他任何请求参数,则默认查询您所有可用的命令(CommandId)。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeCommands |
系统规定参数。取值:DescribeCommands |
RegionId | String | 是 | cn-hangzhou |
地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
CommandId | String | 否 | c-7d2a745b412b4601b2d47f6a768d**** |
命令ID。 |
Name | String | 否 | testName |
命令的名称,暂不支持模糊查询。 |
Description | String | 否 | testDescription |
命令描述。 |
Type | String | 否 | RunShellScript |
命令的类型。取值范围:
|
ContentEncoding | String | 否 | PlainText |
设置返回数据中
默认值:Base64 |
PageNumber | Long | 否 | 1 |
当前页码。起始值:1 默认值:1 |
PageSize | Long | 否 | 10 |
分页查询时设置的每页行数。最大值:50 默认值:10 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Commands | Array |
命令数据集类型。 |
|
Command | |||
CommandContent | String | Y2QgL3Jvb3Q= |
命令内容,以Base64编码后传输。 |
CommandId | String | c-7d2a745b412b4601b2d47f6a768d**** |
命令ID。 |
CreationTime | String | 2018-01-05T15:45:02Z |
命令创建时间。 |
Description | String | testDescription |
命令描述。 |
EnableParameter | Boolean | true |
该命令是否启用自定义参数。 |
InvokeTimes | Integer | 3 |
使用该命令创建的任务数。 |
Name | String | testName |
命令名称。 |
ParameterNames | List | ['parameter1','parameter2'] |
通过创建命令时的CommandContent解析出的自定义参数名列表,以列表(List)的形式返回。如未使用自定义参数功能,则返回空值列表。 |
Timeout | Long | 3600 |
超时时间。 |
Type | String | RunShellScript |
命令类型。 |
WorkingDir | String | /home/ |
执行路径。 |
PageNumber | Long | 1 |
命令列表页码。 |
PageSize | Long | 10 |
每页行数。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID。 |
TotalCount | Long | 5 |
命令总个数。 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeCommands
&RegionId=cn-hangzhou
&CommandId=c-7d2a745b412b4601b2d47f6a768d****
&PageNumber=1
&PageSize=10
&<公共请求参数>
正常返回示例
XML
格式
<DescribeCommandsResponse>
<TotalCount>5</TotalCount>
<Commands>
<Command>
<Name>testName</Name>
<WorkingDir></WorkingDir>
<CommandContent>ZWNobyAxMjM=</CommandContent>
<Timeout>3600</Timeout>
<Type>RunShellScript</Type>
<CommandId>c-7d2a745b412b4601b2d47f6a768d****</CommandId>
<Description>testDescription</Description>
<EnableParameter>false</EnableParameter>
</Command>
<Command>
<Name>Test1</Name>
<WorkingDir></WorkingDir>
<CommandContent>Y2QgL3Jvb3Q=</CommandContent>
<Timeout>3600</Timeout>
<Type>RunShellScript</Type>
<CommandId>c-7d2a745b412b4601b2d47f6a768d****</CommandId>
<Description>test1</Description>
<EnableParameter>false</EnableParameter>
</Command>
<Command>
<Name>Test2</Name>
<WorkingDir></WorkingDir>
<CommandContent>eXVtIHVwZGF0ZQ==</CommandContent>
<Timeout>3600</Timeout>
<Type>RunShellScript</Type>
<CommandId>c-7d2a745b412b4601b2d47f6a768d****</CommandId>
<Description>test2</Description>
</Command>
<Command>
<Name>Test3</Name>
<WorkingDir></WorkingDir>
<CommandContent>c2VydmljZSBuZ2lueCByZWxvYWQ=</CommandContent>
<Timeout>3600</Timeout>
<Type>RunShellScript</Type>
<CommandId>c-7d2a745b412b4601b2d47f6a768d****</CommandId>
<Description>test3</Description>
<EnableParameter>false</EnableParameter>
</Command>
<Command>
<Name>Test4</Name>
<WorkingDir></WorkingDir>
<CommandContent>ZWNobyB7e25hbWV9fSA=</CommandContent>
<Timeout>3600</Timeout>
<Type>RunShellScript</Type>
<CommandId>c-7d2a745b412b4601b2d47f6a768d****</CommandId>
<Description>test4</Description>
<EnableParameter>true</EnableParameter>
<ParameterNames>name</ParameterNames>
</Command>
</Commands>
<PageNumber>1</PageNumber>
<RequestId>E69EF3CC-94CD-42E7-8926-F133B86387C0</RequestId>
<PageSize>10</PageSize>
</DescribeCommandsResponse>
JSON
格式
{
"TotalCount": 5,
"Commands": {
"Command": [
{
"Name": "testName",
"WorkingDir": "",
"CommandContent": "ZWNobyAxMjM=",
"Timeout": 3600,
"Type": "RunShellScript",
"CommandId": "c-7d2a745b412b4601b2d47f6a768d****",
"Description": "testDescription",
"EnableParameter": false,
"ParameterNames": []
},
{
"Name": "Test1",
"WorkingDir": "",
"CommandContent": "Y2QgL3Jvb3Q=",
"Timeout": 3600,
"Type": "RunShellScript",
"CommandId": "c-7d2a745b412b4601b2d47f6a768d****",
"Description": "test1",
"EnableParameter": false,
"ParameterNames": []
},
{
"Name": "Test2",
"WorkingDir": "",
"CommandContent": "eXVtIHVwZGF0ZQ==",
"Timeout": 3600,
"Type": "RunShellScript",
"CommandId": "c-7d2a745b412b4601b2d47f6a768d****",
"Description": "test2"
},
{
"Name": "Test3",
"WorkingDir": "",
"CommandContent": "c2VydmljZSBuZ2lueCByZWxvYWQ=",
"Timeout": 3600,
"Type": "RunShellScript",
"CommandId": "c-7d2a745b412b4601b2d47f6a768d****",
"Description": "test3",
"EnableParameter": false,
"ParameterNames": []
},
{
"Name": "Test4",
"WorkingDir": "",
"CommandContent": "ZWNobyB7e25hbWV9fSA=",
"Timeout": 3600,
"Type": "RunShellScript",
"CommandId": "c-7d2a745b412b4601b2d47f6a768d****",
"Description": "test4",
"EnableParameter": true,
"ParameterNames": [
"name"
]
}
]
},
"PageNumber": 1,
"RequestId": "E69EF3CC-94CD-42E7-8926-F133B86387C0",
"PageSize": 10
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError.Dispatch | An error occurred when you dispatched the request. | 发送请求时发生错误,请稍后重试。 |
403 | InvalidParam.PageNumber | The specified parameter is invalid. | 指定的参数无效。 |
403 | InvalidParam.PageSize | The specified parameter is invalid. | 指定的参数无效。 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交