查询您手动创建的命令或者阿里云提供的公共命令。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| swas-open:DescribeCommands | get | *Command acs:swas-open:{#regionId}:{#accountId}:command/**Command acs:swas-open:{#regionId}:{#accountId}:command/{#CommandId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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**** |
返回参数
示例
正常返回示例
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"
]
}
],
"ResourceGroupId": "rg-aek2bti7cf7****"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-29 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2024-02-20 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |