All Products
Search

This Product

    CloudOps Orchestration Service:StartExecution

    Document Center

    CloudOps Orchestration Service:StartExecution

    Last Updated:Oct 14, 2024

    Starts an execution.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    oos:StartExecutionupdate
    • Execution
      acs:oos:{#regionId}:{#accountId}:execution/*
    • oos:tag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The ID of the region in which the execution resides.

    		cn-hangzhou
    TemplateNamestringNo

    The name of the template. The name must be 1 to 200 characters in length, and can contain letters, digits, hyphens (-), and underscores (_).

    		vmeixme
    TemplateVersionstringNo

    The version number of the template. If you do not specify this parameter, the system uses the latest version.

    		v1
    ModestringNo

    The execution mode. Valid values:

    • Automatic: automatically starts the execution of the template. This is the default value.
    • FailurePause: suspends the execution of the template upon a failure.
    • Debug: manually starts the execution of the template.
    		Automatic
    LoopModestringNo

    The loop mode. Valid values:

    • Automatic: does not suspend the execution of the template. This is the default value.
    • FirstBatchPause: suspends the execution of the template after the first batch is complete.
    • EveryBatchPause: suspends the execution of the template after each batch is complete.
    		Automatic
    ParentExecutionIdstringNo

    The ID of the parent execution.

    		exec-xxx
    SafetyCheckstringNo

    The security check mode. Valid values:

    • Skip: specifies that you are aware of the risks. The system performs all actions in the execution without manual confirmation, regardless of the risk level. This parameter is valid only if the Mode parameter is set to Automatic.
    • ConfirmEveryHighRiskAction: requires you to confirm each high-risk action. This is the default value. You can call the NotifyExecution operation to confirm or cancel an action.
    		Skip
    ParametersstringNo

    The JSON string that consists of a set of parameters. Default value: {}.

    		{"Status":"Running"}
    ClientTokenstringNo

    The access token.

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

    The tags for the execution.

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

    The description of the execution.

    		test execution.
    TemplateContentstringNo

    The content of the template in the JSON or YAML format. This parameter is the same as the Content parameter that you can specify when you call the CreateTemplate operation. You can use this parameter to specify the tasks that you want to run. This way, you do not need to create a template before you start an execution. If you select an existing template, you do not need to specify this parameter.

    		{ "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" } } } ] }
    ResourceGroupIdstringNo

    The ID of the resource group.

    		rg-acfmxsn4m4******
    TemplateURLstringNo

    The Object Storage Service (OSS) URL of the object that stores the content of the Operation Orchestration Service (OOS) template. The access control list (ACL) of the object must be public-read. You can use this parameter to specify the tasks that you want to run. This way, you do not need to create a template before you start an execution. If you select an existing template, you do not need to specify this parameter.

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

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

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

    The details of the execution.

    Outputsstring

    The output of the execution.

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

    The status of the execution.

    		Success
    EndDatestring

    The time when the execution stopped.

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

    The account ID of the user who started the execution of the template.

    		root(13092080xx12344)
    IsParentboolean

    Indicates whether the execution is a parent execution.

    		false
    Tagsobject

    The tags of the execution.

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

    The time when the execution was started.

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

    The security check mode.

    		Skip
    Modestring

    The execution mode.

    		Automatic
    TemplateNamestring

    The name of the template.

    		MyTemplate
    CreateDatestring

    The time when the execution was created.

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

    The version number of the template.

    		v1
    ExecutionIdstring

    The GUID of the execution.

    		exec-xxxyyy
    Parametersstring

    The input parameters of the execution.

    		{ "Status":"Running" }
    Descriptionstring

    The description of the execution.

    		test execution.
    Countersobject

    The number of executions.

    		1
    UpdateDatestring

    The time when the execution was last updated.

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

    The ID of the resource group.

    		rg-acfmxsn4m4******
    ParentExecutionIdstring

    The ID of the parent execution.

    		exec-xxxx
    RamRolestring

    The role that started the execution of the template.

    		OOSServiceRole
    TemplateIdstring

    The ID of the template.

    		t-1bd341007f
    StatusMessagestring

    The status information of the execution.

    		""
    LoopModestring

    The loop mode.

    		Automatic
    CurrentTasksarray<object>

    The information about in-progress tasks.

    CurrentTaskobject
    TaskExecutionIdstring

    The execution ID of the task.

    		exec-dsadasdawq
    TaskNamestring

    The name of the task.

    		testTask
    TaskActionstring

    The action of the task.

    		ACS::TimerTrigger

    Examples

    Sample success responses

    JSONformat

    {
  "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"
      }
    ]
  }
}

    Error codes

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2022-11-07The request parameters of the API has changedView Change Details