StartExecution_系统运维管理_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

请求速率为300/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
oos:StartExecution
Update
Execution
acs:oos:{#regionId}:{#accountId}:execution/*
oos:tag
oos:IsOOSAssumeRole
oos:TLSVersion

请求参数

字段名称字段详情
RegionIdstring

地域 ID

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
TemplateNamestring

模板名称。内容限制为字母、数字、中划线、下划线,长度 200 字符。

示例值:vmeixme参考取值来源:
    UpdateTemplate
    CreateTemplate
    ListTemplates
    GetExecutionTemplate
TemplateVersionstring

版本号,如不填默认为最新的版本号。

示例值:v1参考取值来源:
    ListTemplateVersions
    GetTemplate
    CreateTemplate
    UpdateTemplate
Modestring

执行模式。取值:展开详情

示例值:Automatic
LoopModestring

循环模式。取值:展开详情

示例值:Automatic
ParentExecutionIdstring

父执行 ID

示例值:exec-xxx参考取值来源:
    ListExecutions
SafetyCheckstring

安全检查模式。取值:展开详情

示例值:Skip
Parametersstring

由参数集合组成的 Json 字符串,默认为{}。

示例值:{"Status":"Running"}参考取值来源:
    GetParameters
    ListParameters
ClientTokenstring

访问令牌

示例值:123e56767-e89b-12d3-a456-426655440000
Tagsobject

要给执行打的标签

示例值:{ "k1": "v1", "k2": "v2" }
Descriptionstring

要给执行添加的描述信息

示例值:test execution.
TemplateContentstring

模板内容,JSON 或 YAML 格式(同 CreateTemplate API 请求参数中的 Content 字段)。用户传入此字段可直接执行 TemplateContent 中的任务,而无需提前创建模板再创建执行任务(当用户选择已有的 Template 创建执行任务时不需传入此字段)。

示例值:{ "Description": "Example template, describe instances in some status", "FormatVersion": "OOS-2019-06-01", "Parameters": {}, "Tasks": [ { "Name": "describeInstances", "Action": "ACS::ExecuteAPI", "Description": "desc-en", "Properties": { "Service": "ECS", "API": "DescribeInstances", "Parameters": { "Status": "Running" } } } ] }
ResourceGroupIdstring

资源组 ID

示例值:rg-acfmxsn4m4******
TemplateURLstring

阿里云对象存储 OSS 中存放 OOS 模板内容的 URL(只支持公共读的 URL)。用户传入此字段可直接根据行 TemplateURL 中存储的模板内容创建执行任务,无需提前创建模板再创建执行任务(当用户选择已有的 Template 创建执行任务时不需传入此字段)。

示例值:http://oos-template.cn-hangzhou.oss.aliyun-inc.com/oos-test-template.json

返回参数

字段名称字段详情
RequestIdstring

请求 ID

示例值:14A07460-EBE7-47CA-9757-12CC4761D47A
Executionobject

执行数据

返回示例

变更历史

暂无变更历史

相关示例

该项目为使用OOS 到ECS实例上执行命令的 CodeSample,生成的代码可以通过安装各语言的包来进行测试。
2022-07-27