全部產品
Search

搜尋本產品

    CloudOps Orchestration Service：StartExecution - 啟動一個執行

    文件中心

    CloudOps Orchestration Service：StartExecution - 啟動一個執行

    更新時間：Apr 28, 2026

    啟動一個執行。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    oos:StartExecution

    update

    *Execution

    acs:oos:{#regionId}:{#accountId}:execution/*
    • oos:tag
    • oos:IsOOSAssumeRole
    • oos:TLSVersion
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    否

    地區 ID

    cn-hangzhou
    TemplateName

    string

    否

    模板名稱。內容限制為字母、數字、中劃線、底線，長度 200 字元。

    vmeixme
    TemplateVersion

    string

    否

    版本號碼，如不填預設為最新的版本號碼。

    v1
    Mode

    string

    否

    執行模式。取值：

    • Automatic（預設值）：自動執行

    • FailurePause：失敗暫停

    • Debug：逐步執行

    Automatic
    LoopMode

    string

    否

    迴圈模式。取值：

    • Automatic（預設值）：不暫停

    • FirstBatchPause：第一批暫停

    • EveryBatchPause：每批暫停

    Automatic
    ParentExecutionId deprecated

    string

    否

    父執行 ID

    exec-xxx
    SafetyCheck

    string

    否

    安全檢查模式。取值：

    • Skip（預設值）：此選項表示客戶瞭解風險，無需確認即可執行任何 Action，無論什麼風險等級。Mode=Automatic時有效。

    • ConfirmEveryHighRiskAction：此選項會要求客戶確認每一個高風險的 Action。客戶通過調用 NotifyExecution 介面進行確認或取消。

    Skip
    Parameters

    string

    否

    由參數集合組成的 Json 字串，預設為{}。

    {"Status":"Running"}
    ClientToken

    string

    否

    存取權杖

    123e56767-e89b-12d3-a456-426655440000
    Tags

    object

    否

    要給執行打的標籤

    { "k1": "v1", "k2": "v2" }
    Description

    string

    否

    要給執行添加的描述資訊

    test execution.
    TemplateContent

    string

    否

    模板內容，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" } } } ] }
    ResourceGroupId

    string

    否

    資源群組 ID

    rg-acfmxsn4m4******
    TemplateURL

    string

    否

    阿里雲Object Storage Service 中存放 OOS 模板內容的 URL(只支援公用讀取的 URL)。使用者傳入此欄位可直接根據行 TemplateURL 中儲存的模板內容建立執行任務，無需提前建立模板再建立執行任務（當使用者選擇已有的 Template 建立執行任務時不需傳入此欄位）。

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID

    14A07460-EBE7-47CA-9757-12CC4761D47A
    Execution

    object

    執行資料

    Outputs

    string

    執行輸出結果

    { "InstanceId":"i-xxx" }
    Status

    string

    執行狀態

    Success
    EndDate

    string

    結束時間

    2019-05-16T10:26:14Z
    ExecutedBy

    string

    執行模板者

    root(13092080xx12344)
    IsParent

    boolean

    是否包含子任務

    false
    Tags

    object

    執行的標籤

    {"k1":"v2","k2":"v2"}
    StartDate

    string

    開始時間

    2019-05-16T10:26:14Z
    SafetyCheck

    string

    安全檢查模式

    Skip
    Mode

    string

    執行模式

    Automatic
    TemplateName

    string

    模板名稱

    MyTemplate
    CreateDate

    string

    執行建立時間

    2019-05-16T10:26:14Z
    TemplateVersion

    string

    模板版本號碼

    v1
    ExecutionId

    string

    執行的唯一標識

    exec-xxxyyy
    Parameters

    string

    執行的輸入參數

    { "Status":"Running" }
    Description

    string

    執行的描述資訊

    test execution.
    Counters

    object

    執行數

    1
    UpdateDate

    string

    更新時間

    2019-05-16T10:26:14Z
    ResourceGroupId

    string

    資源群組 ID

    rg-acfmxsn4m4******
    ParentExecutionId

    string

    父執行 ID

    exec-xxxx
    RamRole

    string

    執行當前模板的角色

    OOSServiceRole
    TemplateId

    string

    模板 ID

    t-1bd341007f
    StatusMessage

    string

    狀態資訊

    ""
    LoopMode

    string

    迴圈模式

    Automatic
    CurrentTasks

    array<object>

    當前正在啟動並執行 Tasks

    object

    TaskExecutionId

    string

    任務執行 ID

    exec-dsadasdawq
    TaskName

    string

    任務名稱

    testTask
    TaskAction

    string

    任務的動作

    ACS::TimerTrigger

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "Execution": {
    "Outputs": "{ \"InstanceId\":\"i-xxx\" }",
    "Status": "Success",
    "EndDate": "2019-05-16T10:26:14Z",
    "ExecutedBy": "root(13092080xx12344)",
    "IsParent": false,
    "Tags": {
      "k1": "v2",
      "k2": "v2"
    },
    "StartDate": "2019-05-16T10:26:14Z",
    "SafetyCheck": "Skip",
    "Mode": "Automatic",
    "TemplateName": "MyTemplate",
    "CreateDate": "2019-05-16T10:26:14Z",
    "TemplateVersion": "v1",
    "ExecutionId": "exec-xxxyyy",
    "Parameters": "{ \"Status\":\"Running\" }",
    "Description": "test execution.",
    "Counters": 1,
    "UpdateDate": "2019-05-16T10:26:14Z",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "ParentExecutionId": "exec-xxxx",
    "RamRole": "OOSServiceRole",
    "TemplateId": "t-1bd341007f",
    "StatusMessage": "\"\"",
    "LoopMode": "Automatic",
    "CurrentTasks": [
      {
        "TaskExecutionId": "exec-dsadasdawq",
        "TaskName": "testTask",
        "TaskAction": "ACS::TimerTrigger"
      }
    ]
  }
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。