新建一条命令助手命令。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
swas-open:CreateCommand | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。您可以调用 ListRegions 查询可用地域。 | cn-hangzhou |
Name | string | 是 | 命令名称,支持全字符集。长度不得超过 128 个字符。 | testName |
Description | string | 否 | 命令描述,支持全字符集。长度不得超过 512 个字符。 | test |
Type | string | 是 | 命令的语言类型。取值范围:
| RunShellScript |
CommandContent | string | 是 | 命令内容。您需要注意:
| ifconfig -s |
WorkingDir | string | 否 | 您创建的命令在 ECS 实例中运行的目录。 默认值:
| /root/ |
Timeout | long | 否 | 设置命令在服务器实例中的超时时间,单位为秒。 当执行命令的任务超时后,命令助手将强制终止任务进程。可设定超时时间取值范围为 10~86400 秒(24 小时)。 默认值:60。 | 60 |
EnableParameter | boolean | 否 | 创建的命令是否使用自定义参数。 默认值为 false。 | false |
Tag | array<object> | 否 | 标签列表,最多包含 20 个子项。 | |
object | 否 | 标签。 | ||
Key | string | 否 | 为命令指定的标签键。N 的取值范围:1~20。 一旦传入该值,则不允许为空字符串。最多支持 64 个字符,不能以 aliyun 和 acs:开头,不能包含 http://或者 https://。 | TestKey |
Value | string | 否 | 为命令指定的标签值。N 的取值范围:1~20。 一旦传入该值,可以为空字符串。最多支持 64 个字符,不能包含 http://或者 https://。 | TestValue |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-aek2bti7cf7**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "20758A-585D-4A41-A9B2-28DA8F4****",
"CommandId": "c-sh02yh0932w****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-29 | OpenAPI 入参发生变更 | 查看变更详情 |
2024-02-20 | OpenAPI 入参发生变更 | 查看变更详情 |