查询您手动创建的命令或者阿里云提供的公共命令。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 | object [] | 否 | 命令的标签列表。 | |
Key | string | 否 | 命令的标签键。标签键长度的取值范围:1~64。N 的取值范围:1~20。 | TestKey |
Value | string | 否 | 命令的标签值。标签值长度的取值范围:1~64。N 的取值范围:1~20。 | TestValue |
返回参数
示例
正常返回示例
JSON
格式
{
"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"
]
}
]
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2024-02-20 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||
|