All Products
Search
Document Center

CloudOps Orchestration Service:GenerateExecutionPolicy

Last Updated:Oct 14, 2024

Queries the Resource Access Management (RAM) policy required for template 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:GenerateExecutionPolicyget
  • Template
    acs:oos:{#regionId}:{#accountId}:template/{#templateName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region.

cn-hangzhou
TemplateNamestringYes

The name of the template.

vmeixme
TemplateVersionstringNo

The version of the template. The default value is the latest version of the template.

v2
RamRolestringNo

The RAM role.

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

Response parameters

ParameterTypeDescriptionExample
object
Policystring

The RAM policy.

{}
RequestIdstring

The ID of the request.

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

The policies that are missing.

[{'Action': ['ecs:DescribeInvocationResults', 'ecs:DescribeInstances', 'ecs:RunCommand', 'ecs:DescribeInvocations'], 'ServiceName': 'ecs', 'Resources': '*'}]

Examples

Sample success responses

JSONformat

{
  "Policy": "{}",
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "MissingPolicy": "[{'Action': ['ecs:DescribeInvocationResults', 'ecs:DescribeInstances', 'ecs:RunCommand', 'ecs:DescribeInvocations'], 'ServiceName': 'ecs', 'Resources': '*'}]"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-12-08The request parameters of the API has changedView Change Details
2022-12-05The request parameters of the API has changed. The response structure of the API has changedView Change Details