All Products
Search
Document Center

CloudOps Orchestration Service:RAM authorization

Last Updated:Sep 21, 2023
Resource Access Management (RAM) is a service provided by Alibaba Cloud to manage user identities and resource access permissions. You can use RAM to prevent RAM users from sharing the AccessKey pairs of your Alibaba Cloud account. You can also use RAM to grant minimum permissions to RAM users. RAM uses policies to define permissions.
This topic describes the elements, such as Action, Resource, and Condition, which are defined by OOS. You can use the elements to create policies in RAM. The code (RamCode) in RAM that is used to indicate OOS is oos. You can grant permissions on OOS at the RESOURCE.

General structure of a policy

Policies can be stored as JSON files. The following code provides an example on the general structure of a policy:
{
  "Version": "1",
  "Statement": [
    {
      "Effect": "<Effect>",
      "Action": "<Action>",
      "Resource": "<Resource>",
      "Condition": {
        "<Condition_operator>": {
          "<Condition_key>": [
            "<Condition_value>"
          ]
        }
      }
    }
  ]
}
The following list describes the fields in the policy:
  • Effect: specifies the authorization effect. Valid values: Allow, Deny.
  • Action: specifies one or more API operations that are allowed or denied. For more information, see the Action section of this topic.
  • Resource: specifies one or more resources to which the policy applies. You can use an Alibaba Cloud Resource Name (ARN) to specify a resource. For more information, see the Resource section of this topic.
  • Condition: specifies one or more conditions that are required for the policy to take effect. This is an optional field. For more information, see the Condition section of this topic.
    • Condition_operator: specifies the conditional operators. Different types of conditions support different conditional operators. For more information, see Policy elements.
    • Condition_key: specifies the condition keys.
    • Condition_value: specifies the condition values.

Action

OOS defines the values that you can use in the Action element of a policy statement. The following table describes the values.
  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • API operation: the API operation that you can call to perform the operation.
  • 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 keys that are defined by the Alibaba Cloud service. The Condition key column does not list the common condition keys that are defined by Alibaba Cloud. For more information about the common condition keys, see Generic Condition Keyword.
  • 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.
ActionsAPI operationAccess levelResource typeCondition keyAssociated operation
oos:CancelExecutionCancelExecutionWrite
Execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
oos:tag
None
oos:ChangeResourceGroupChangeResourceGroupWrite
All Resources
acs:oos:*:{#accountId}:*
NoneNone
oos:CreateApplicationCreateApplicationWrite
Application
acs:oos:{#regionId}:{#accountId}:application/*
NoneNone
oos:CreateApplicationGroupCreateApplicationGroupWrite
Application
acs:oos:{#regionId}:{#accountId}:application/*
NoneNone
oos:CreateParameterCreateParameterWrite
parameter
acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
NoneNone
oos:CreatePatchBaselineCreatePatchBaselineWrite
patchbaseline
acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}
NoneNone
oos:CreateSecretParameterCreateSecretParameterWrite
secretparameter
acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
NoneNone
oos:CreateStateConfigurationCreateStateConfigurationWrite
stateconfiguration
acs:oos:{#regionId}:{#accountId}:stateconfiguration/*
template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
NoneNone
oos:CreateTemplateCreateTemplateWrite
template
acs:oos:{#regionId}:{#accountId}:template/*
oos:tag
None
oos:DeleteApplicationDeleteApplicationRead
Application
acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}
NoneNone
oos:DeleteApplicationGroupDeleteApplicationGroupWrite
Application
acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}
NoneNone
oos:DeleteExecutionsDeleteExecutionsWrite
Execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
oos:tag
None
oos:DeleteParameterDeleteParameterWrite
parameter
acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
NoneNone
oos:DeletePatchBaselineDeletePatchBaselineWrite
patchbaseline
acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}
NoneNone
oos:DeleteSecretParameterDeleteSecretParameterWrite
secretparameter
acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
NoneNone
oos:DeleteStateConfigurationsDeleteStateConfigurationsWrite
stateconfiguration
acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#stateconfigurationId}
NoneNone
oos:DeleteTemplateDeleteTemplateWrite
Template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
oos:tag
None
oos:DeleteTemplatesDeleteTemplatesWrite
Template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
NoneNone
oos:GenerateExecutionPolicyGenerateExecutionPolicyWrite
Template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
NoneNone
oos:GetApplicationGetApplicationRead
Application
acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}
NoneNone
oos:GetApplicationGroupGetApplicationGroupRead
Application
acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}
NoneNone
oos:GetExecutionTemplateGetExecutionTemplateRead
Execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
oos:tag
None
oos:GetParameterGetParameterRead
parameter
acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
NoneNone
oos:GetParametersGetParametersRead
parameter
acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
NoneNone
oos:GetParametersByPathGetParametersByPathRead
parameter
acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
NoneNone
oos:GetPatchBaselineGetPatchBaselineRead
patchbaseline
acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}
NoneNone
oos:GetSecretParameterGetSecretParameterRead
secretparameter
acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
NoneNone
oos:GetSecretParametersGetSecretParametersRead
secretparameter
acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
NoneNone
oos:GetSecretParametersByPathGetSecretParametersByPathRead
secretparameter
acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
NoneNone
oos:GetServiceSettingsGetServiceSettingsRead
All Resources
acs:oos:{#regionId}:{#accountId}:*
NoneNone
oos:GetTemplateGetTemplateRead
template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
oos:tag
None
oos:ListApplicationGroupsListApplicationGroupsList
Application
acs:oos:{#regionId}:{#accountId}:application/*
NoneNone
oos:ListApplicationsListApplicationsList
Application
acs:oos:{#regionId}:{#accountId}:application/*
NoneNone
oos:ListExecutionLogsListExecutionLogsList
execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
oos:tag
None
oos:ListExecutionRiskyTasksListExecutionRiskyTasksList
template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
oos:tag
None
oos:ListExecutionsListExecutionsRead
execution
acs:oos:{#regionId}:{#accountId}:execution/*
execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
oos:tag
None
oos:ListInstancePatchStatesListInstancePatchStatesList
All Resources
acs:oos:{#regionId}:{#accountId}:*
NoneNone
oos:ListInstancePatchesListInstancePatchesList
All Resources
acs:oos:{#regionId}:{#accountId}:*
NoneNone
oos:ListInventoryEntriesListInventoryEntriesList
All Resources
acs:oos:{#regionId}:{#accountId}:*
NoneNone
oos:ListParameterVersionsListParameterVersionsList
parameter
acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
NoneNone
oos:ListParametersListParametersList
parameter
acs:oos:{#regionId}:{#accountId}:parameter/*
NoneNone
oos:ListPatchBaselinesListPatchBaselinesList
patchbaseline
acs:oos:{#regionId}:{#accountId}:patchbaseline/*
NoneNone
oos:ListResourceExecutionStatusListResourceExecutionStatusList
execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
oos:tag
None
oos:ListSecretParameterVersionsListSecretParameterVersionsList
secretparameter
acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
NoneNone
oos:ListSecretParametersListSecretParametersList
secretparameter
acs:oos:{#regionId}:{#accountId}:secretparameter/*
NoneNone
oos:ListStateConfigurationsListStateConfigurationsRead
stateconfiguration
acs:oos:{#regionId}:{#accountId}:stateconfiguration/*
stateconfiguration
acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#stateconfigurationId}
NoneNone
oos:ListTagKeysListTagKeysList
tags
acs:oos:{#regionId}:{#accountId}:tags/*
NoneNone
oos:ListTagResourcesListTagResourcesList
template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
Execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
oos:tag
None
oos:ListTagValuesListTagValuesList
tags
acs:oos:{#regionId}:{#accountId}:tags/*
NoneNone
oos:ListTaskExecutionsListTaskExecutionsRead
execution
acs:oos:{#regionId}:{#accountId}:execution/*
execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
oos:tag
None
oos:ListTemplateVersionsListTemplateVersionsList
Template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
NoneNone
oos:ListTemplatesListTemplatesRead
Template
acs:oos:{#regionId}:{#accountId}:template/*
Template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
oos:tag
None
oos:NotifyExecutionNotifyExecutionWrite
execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
oos:tag
None
oos:RegisterDefaultPatchBaselineRegisterDefaultPatchBaselineWrite
patchbaseline
acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}
NoneNone
oos:SearchInventorySearchInventoryRead
All Resources
acs:oos:{#regionId}:{#accountId}:*
NoneNone
oos:SetServiceSettingsSetServiceSettingsWrite
All Resources
acs:oos:{#regionId}:{#accountId}:*
NoneNone
oos:StartExecutionStartExecutionWrite
execution
acs:oos:{#regionId}:{#accountId}:execution/*
template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
oos:tag
None
oos:TagResourcesTagResourcesWrite
execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
oos:tag
None
oos:TriggerExecutionTriggerExecutionWrite
execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
NoneNone
oos:UntagResourcesUntagResourcesWrite
execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
oos:tag
None
oos:UpdateApplicationGroupUpdateApplicationGroupWrite
Application
acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}
NoneNone
oos:UpdateExecutionUpdateExecutionWrite
execution
acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
NoneNone
oos:UpdateParameterUpdateParameterWrite
parameter
acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
NoneNone
oos:UpdatePatchBaselineUpdatePatchBaselineWrite
patchbaseline
acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}
NoneNone
oos:UpdateSecretParameterUpdateSecretParameterWrite
secretparameter
acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
NoneNone
oos:UpdateStateConfigurationUpdateStateConfigurationWrite
stateconfiguration
acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#stateconfigurationId}
NoneNone
oos:UpdateTemplateUpdateTemplateWrite
template
acs:oos:{#regionId}:{#accountId}:template/{#templateName}
oos:tag
None

Resource

OOS defines the values that you can use in the Resource. You can attach the policy to a RAM user or a RAM role so that the RAM user or the RAM role can perform a specific operation on a specific resource. The ARN is the unique identifier of the resource on Alibaba Cloud. Take note of the following items:
  • {#}indicates a variable. {#} must be replaced with an actual value. For example, {#ramcode} must be replaced with the actual code of an Alibaba Cloud service in RAM.
  • An asterisk (*) is used as a wildcard. Examples:
    • {#resourceType} is set to *, all resources are specified.
    • {#regionId} is set to *, all regions are specified.
    • {#accountId} is set to *, all Alibaba Cloud accounts are specified.
Resource typeARN
Executionacs:{#ramcode}:{#regionId}:{#accountId}:execution/{#ExecutionId}
Templateacs:{#ramcode}:{#regionId}:{#accountId}:template/{#TemplateName}
Applicationacs:{#ramcode}:{#regionId}:{#accountId}:application/{#ApplicationName}

Condition

OOS defines the values that you can use in the Condition element of a policy statement. The following table describes the values. The following table describes the service-specific condition keys. The common condition keys that are defined by Alibaba Cloud also apply to OOS. For more information about the common condition keys, see Generic Condition Keyword.
The data type determines the conditional operators that you can use to compare the value in a request with the value in a policy statement. You must use conditional operators that are supported by the data type. Otherwise, you cannot compare the value in the request with the value in the policy statement. In this case, the authorization is invalid. For more information about the conditional operators that are supported by each data type, see Policy elements.
Condition keyDescriptionData type
oos:tagoos:tagSTRING

What to do next

You can create a custom policy and attach the policy to a RAM user, RAM user group, or RAM role. For more information, see the following topics: