RAM authorization - CloudOps Orchestration Service - Alibaba Cloud Documentation Center

Resource Access Management (RAM) is a service provided by Alibaba Cloud to manage user identities and resource access permissions. Using RAM helps you avoid sharing your Alibaba Cloud account keys with other users and allows you to grant users the least privilege access. RAM uses permission policies to define authorizations. This topic describes the general structure of a RAM policy, and the policy statement elements (Action, Resource, and Condition) defined by CloudOps Orchestration Service for RAM permission policies. The RAM code (RamCode) for CloudOps Orchestration Service is oos , and the supported authorization granularity is RESOURCE .

General structure of a policy

Permission policies support JSON format with the following general structure:

{
  "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:

Version: Specifies the policy version number. It is fixed at 1.
Statement:
- Effect: Specifies the authorization result. Valid values: Allow and Deny.
- Action: Specifies one or more operations that are allowed or denied.
- Resource: Specifies the specific objects affected by the operations. You can use Alibaba Cloud Resource Names (ARNs) to describe specific resources.
- Condition: Specifies the conditions for the authorization to take effect. This field is optional.
  - Condition operator: Specifies the conditional operators. Different types of conditions support different conditional operators.
  - Condition_key: Specifies the condition keys.
  - Condition_value: Specifies the condition values.

Action

The following table lists the actions defined by CloudOps Orchestration Service . The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding ARN in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys that are applicable across all RAM-integrated services. For more information, see Common condition keys.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action	API	Access level	Resource type	Condition key	Dependent action
oos:GetTemplateParameterConstraints	GetTemplateParameterConstraints	get	*Template `acs:oos:{#regionId}:{#accountId}:template/{#TemplateName}`	oos:TLSVersion	None
oos:CreateSecretParameter	CreateSecretParameter	create	*secretparameter `acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}`	oos:TLSVersion	None
oos:ListParameterVersions	ListParameterVersions	list	*parameter `acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}`	oos:TLSVersion	None
oos:TriggerExecution	TriggerExecution	update	*execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}`	oos:TLSVersion	None
oos:RegisterDefaultPatchBaseline	RegisterDefaultPatchBaseline	update	*patchbaseline `acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}`	oos:TLSVersion	None
oos:ListTagKeys	ListTagKeys	get	All Resource ``	oos:TLSVersion	None
oos:CreateApplication	CreateApplication	create	Application `acs:oos:{#regionId}:{#accountId}:application/`	oos:TLSVersion	None
oos:ChangeResourceGroup	ChangeResourceGroup	update	Template `acs:oos:{#regionId}:{#accountId}:template/{#TemplateName}` StateConfiguration `acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#StateConfigurationId}` Parameter `acs:oos:{#regionId}:{#accountId}:parameter/{#ParameterName}` SecretParameter `acs:oos:{#regionId}:{#accountId}:secretparameter/{#SecretParameterName}` OpsItem `acs:oos:{#regionId}:{#accountId}:opsitem/{#OpsItemId}` PatchBaseline `acs:oos:{#regionId}:{#accountId}:patchbaseline/{#PatchBaselineName}` *Execution `acs:oos:{#regionId}:{#accountId}:execution/{#ExecutionId}`	oos:TLSVersion	None
oos:GetParameter	GetParameter	get	*parameter `acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}`	oos:TLSVersion	None
oos:ListTemplateVersions	ListTemplateVersions	list	*Template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:TLSVersion	None
oos:DeleteOpsItems	DeleteOpsItems	delete	*OpsItem `acs:oos:{#regionId}:{#accountId}:opsitem/{#OpsItemId}`	oos:tag oos:TLSVersion	None
oos:CreateParameter	CreateParameter	create	*parameter `acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}`	oos:TLSVersion	None
oos:TagResources	TagResources	update	execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}` template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:tag oos:TLSVersion	None
oos:CreatePatchBaseline	CreatePatchBaseline	create	*patchbaseline `acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}`	oos:TLSVersion	None
oos:GetSecretParameter	GetSecretParameter	get	*secretparameter `acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}`	oos:TLSVersion	None
oos:ListApplications	ListApplications	list	Application `acs:oos:{#regionId}:{#accountId}:application/`	oos:TLSVersion	None
oos:StartExecution	StartExecution	update	Execution `acs:oos:{#regionId}:{#accountId}:execution/`	oos:tag oos:IsOOSAssumeRole oos:TLSVersion	None
oos:UpdateTemplate	UpdateTemplate	update	*template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:tag oos:TLSVersion	ram:PassRole
oos:DescribeRegions	DescribeRegions	get	All Resource ``	oos:TLSVersion	None
oos:GetSecretParameters	GetSecretParameters	get	*secretparameter `acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}`	oos:TLSVersion	None
oos:DeleteApplication	DeleteApplication	delete	*Application `acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}`	oos:TLSVersion	None
oos:GetParametersByPath	GetParametersByPath	get	*parameter `acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}`	oos:TLSVersion	None
oos:ListSecretParameters	ListSecretParameters	list	SecretParameter `acs:oos:{#regionId}:{#accountId}:secretparameter/`	oos:TLSVersion	None
oos:ListExecutionRiskyTasks	ListExecutionRiskyTasks	get	*template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:tag oos:TLSVersion	None
oos:ListInventoryEntries	ListInventoryEntries	get	All Resource ``	oos:TLSVersion	None
oos:GetSecretParametersByPath	GetSecretParametersByPath	get	*secretparameter `acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}`	oos:TLSVersion	None
oos:GetPatchBaseline	GetPatchBaseline	get	*patchbaseline `acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}`	oos:TLSVersion	None
oos:SetServiceSettings	SetServiceSettings	update	*ServiceSetting `acs:oos:{#regionId}:{#accountId}:ServiceSetting`	oos:TLSVersion	None
oos:GenerateOpsItem	GenerateOpsItem	create	All Resource ``	oos:TLSVersion	None
oos:GetInventorySchema	GetInventorySchema	get	All Resource ``	oos:TLSVersion	None
oos:GenerateExecutionPolicy	GenerateExecutionPolicy	get	*Template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:TLSVersion	None
oos:UpdatePatchBaseline	UpdatePatchBaseline	update	*patchbaseline `acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}`	oos:TLSVersion	None
oos:CreateApplicationGroup	CreateApplicationGroup	create	*ApplicationGroup `acs:oos:{#regionId}:{#accountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName}`	oos:TLSVersion	None
oos:SearchInventory	SearchInventory	get	All Resource ``	oos:TLSVersion	None
oos:DeleteExecutions	DeleteExecutions	delete	*Execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}`	oos:tag oos:TLSVersion	None
oos:ValidateTemplateContent	ValidateTemplateContent	get	All Resource ``	oos:TLSVersion	None
oos:ListPatchBaselines	ListPatchBaselines	list	*PatchBaseline `acs:oos:{#regionId}:{#accountId}:patchbaseline/{#PatchBaselineName}`	oos:TLSVersion	None
oos:ContinueDeployApplicationGroup	ContinueDeployApplicationGroup	update	*ApplicationGroup `acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName}`	oos:TLSVersion	None
oos:ListInstancePatchStates	ListInstancePatchStates	list	All Resource ``	oos:TLSVersion	None
oos:DescribeApplicationGroupBill	DescribeApplicationGroupBill	get	*ApplicationGroup `acs:oos:{#regionId}:{#AccountId}:application/{#ApplicationName}/applicationgroup/{#ApplicationGroupName}`	oos:TLSVersion	None
oos:ListResourceExecutionStatus	ListResourceExecutionStatus	get	*execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}`	oos:tag oos:TLSVersion	None
oos:GetOpsItem	GetOpsItem	get	*OpsItem `acs:oos:{#regionId}:{#accountId}:opsitem/{#OpsItemId}`	oos:TLSVersion	None
oos:CancelExecution	CancelExecution	update	*Execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}`	oos:tag oos:TLSVersion	None
oos:GetServiceSettings	GetServiceSettings	get	*ServiceSetting `acs:oos:{#regionId}:{#accountId}:ServiceSetting`	oos:TLSVersion	None
oos:ListOpsItems	ListOpsItems	list	OpsItem `acs:oos:{#regionId}:{#accountId}:opsitem/`	oos:TLSVersion	None
oos:DeployApplicationGroup	DeployApplicationGroup	update	*ApplicationGroup `acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName}`	oos:TLSVersion	None
oos:DeleteSecretParameter	DeleteSecretParameter	delete	*secretparameter `acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}`	oos:TLSVersion	None
oos:ListStateConfigurations	ListStateConfigurations	get	StateConfiguration `acs:oos:{#regionId}:{#accountId}:stateconfiguration/` *StateConfiguration `acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#StateConfigurationId}`	oos:TLSVersion	None
oos:UpdateApplicationGroup	UpdateApplicationGroup	update	*ApplicationGroup `acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName}`	oos:TLSVersion	None
oos:ListInstancePackageStates	ListInstancePackageStates	list	*Template `acs:oos:{#regionId}:{#accountId}:template/{#templateNames}`	oos:tag oos:TLSVersion	None
oos:NotifyExecution	NotifyExecution	update	*execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}`	oos:tag oos:TLSVersion	None
oos:ListExecutions	ListExecutions	list	Execution `acs:oos:{#regionId}:{#accountId}:execution/` *Execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}`	oos:tag oos:TLSVersion	None
oos:UpdateStateConfiguration	UpdateStateConfiguration	update	*stateconfiguration `acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#stateconfigurationId}`	oos:TLSVersion	None
oos:GetApplicationGroup	GetApplicationGroup	get	*ApplicationGroup `acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName}`	oos:TLSVersion	None
oos:DeleteTemplate	DeleteTemplate	delete	*Template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:tag oos:TLSVersion	None
oos:CreateTemplate	CreateTemplate	create	Template `acs:oos:{#regionId}:{#accountId}:template/`	oos:tag oos:TLSVersion	ram:PassRole
oos:UpdateSecretParameter	UpdateSecretParameter	update	*secretparameter `acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}`	oos:TLSVersion	None
oos:ListInstancePatches	ListInstancePatches	list	All Resource ``	oos:TLSVersion	None
oos:GetExecutionTemplate	GetExecutionTemplate	get	*Execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}`	oos:tag oos:TLSVersion	None
oos:ListTagValues	ListTagValues	get	All Resource ``	oos:TLSVersion	None
oos:ListSecretParameterVersions	ListSecretParameterVersions	list	*secretparameter `acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}`	oos:TLSVersion	None
oos:ListParameters	ListParameters	list	Parameter `acs:oos:{#regionId}:{#accountId}:parameter/`	oos:TLSVersion	None
oos:DeleteApplicationGroup	DeleteApplicationGroup	delete	*ApplicationGroup `acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName}`	oos:TLSVersion	None
oos:ListTemplates	ListTemplates	get	Template `acs:oos:{#regionId}:{#accountId}:template/*` Template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:tag oos:TLSVersion	None
oos:GetTemplate	GetTemplate	get	*template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:tag oos:TLSVersion	None
oos:ListTaskExecutions	ListTaskExecutions	get	*Execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}`	oos:tag oos:TLSVersion	None
oos:UpdateApplication	UpdateApplication	update	*Application `acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}`	oos:TLSVersion	None
oos:ListApplicationGroups	ListApplicationGroups	list	ApplicationGroup `acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/`	oos:TLSVersion	None
oos:DeleteParameter	DeleteParameter	delete	*parameter `acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}`	oos:TLSVersion	None
oos:ListTagResources	ListTagResources	get	Execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}` Template `acs:oos:{#regionId}:{#accountId}:template/{#TemplateName}` StateConfiguration `acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#StateConfigurationId}` Parameter `acs:oos:{#regionId}:{#accountId}:parameter/{#ParameterName}` SecretParameter `acs:oos:{#regionId}:{#accountId}:secretparameter/{#SecretParameterName}` OpsItem `acs:oos:{#regionId}:{#accountId}:opsitem/{#OpsItemId}` PatchBaseline `acs:oos:{#regionId}:{#accountId}:patchbaseline/{#PatchBaselineName}` Execution `acs:oos:{#regionId}:{#accountId}:execution/` Template `acs:oos:{#regionId}:{#accountId}:template/` OpsItem `acs:oos:{#regionId}:{#accountId}:opsitem/` SecretParameter `acs:oos:{#regionId}:{#accountId}:secretparameter/` PatchBaseline `acs:oos:{#regionId}:{#accountId}:patchbaseline/` StateConfiguration `acs:oos:{#regionId}:{#accountId}:stateconfiguration/` Parameter `acs:oos:{#regionId}:{#accountId}:parameter/*`	oos:tag oos:TLSVersion	None
oos:UpdateExecution	UpdateExecution	update	*execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}`	oos:TLSVersion	None
oos:DeletePatchBaseline	DeletePatchBaseline	delete	*PatchBaseline `acs:oos:{#regionId}:{#accountId}:patchbaseline/{#Name}`	oos:TLSVersion	None
oos:CreateStateConfiguration	CreateStateConfiguration	create	StateConfiguration `acs:oos:{#regionId}:{#accountId}:stateconfiguration/`	oos:TLSVersion	None
oos:DeleteStateConfigurations	DeleteStateConfigurations	delete	*stateconfiguration `acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#stateconfigurationId}`	oos:TLSVersion	None
oos:GetParameters	GetParameters	get	*parameter `acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}`	oos:TLSVersion	None
oos:UpdateParameter	UpdateParameter	update	*parameter `acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}`	oos:TLSVersion	None
oos:UpdateOpsItem	UpdateOpsItem	update	*OpsItem `acs:oos:{#regionId}:{#accountId}:opsitem/{#OpsItemId}`	oos:TLSVersion	None
oos:GetApplication	GetApplication	get	*Application `acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}`	oos:TLSVersion	None
oos:UpdateInstancePackageState	UpdateInstancePackageState	update	*Template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:tag oos:TLSVersion	None
oos:ListExecutionLogs	ListExecutionLogs	get	*execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}`	oos:tag oos:TLSVersion	None
oos:DeleteTemplates	DeleteTemplates	delete	*Template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:TLSVersion	None
oos:CreateOpsItem	CreateOpsItem	create	OpsItem `acs:oos:{#regionId}:{#accountId}:opsitem/`	oos:TLSVersion	None
oos:UntagResources	UntagResources	update	execution `acs:oos:{#regionId}:{#accountId}:execution/{#executionId}` template `acs:oos:{#regionId}:{#accountId}:template/{#templateName}`	oos:tag oos:TLSVersion	None

Resource

The following table lists the resources defined by CloudOps Orchestration Service . Specify them in the Resource element of RAM policy statements to grant permissions for specific operations. They are uniquely identified by ARNs. Format: acs:{#ramcode}:{#regionId}:{#accountId}:{#resourceType}:

acs: The initialism of Alibaba Cloud service, which indicates the public cloud of Alibaba Cloud.
{#ramcode}: The code used in RAM to indicate an Alibaba Cloud service.
{#regionId}: The region ID. If the resource covers all regions, set it to an asterisk (*).
{#accountId}: The ID of the Alibaba Cloud account. If the resource covers all Alibaba Cloud accounts, set it to an asterisk (*).
{#resourceType}: The service-defined resource identifier. It supports a hierarchical structure, which is similar to a file path. If the statement covers global resources, set it to an asterisk (*).

Resource type	ARN
Template	acs:oos:{#regionId}:{#accountId}:template/{#TemplateName} acs:oos:{#regionId}:{#accountId}:template/{#templateNames} acs:oos:{#regionId}:{#accountId}:template/*
secretparameter	acs:oos:{#regionId}:{#accountId}:secretparameter/{#secretparameterName}
parameter	acs:oos:{#regionId}:{#accountId}:parameter/{#parameterName}
execution	acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
patchbaseline	acs:oos:{#regionId}:{#accountId}:patchbaseline/{#patchbaselineName}
tags	acs:oos:{#regionId}:{#accountId}:tags/*
Application	acs:oos:{#regionId}:{#accountId}:application/* acs:oos:{#regionId}:{#accountId}:application/{#ApplicationName}
StateConfiguration	acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#StateConfigurationId} acs:oos:{#regionId}:{#accountId}:stateconfiguration/*
Parameter	acs:oos:{#regionId}:{#accountId}:parameter/{#ParameterName} acs:oos:{#regionId}:{#accountId}:parameter/*
SecretParameter	acs:oos:{#regionId}:{#accountId}:secretparameter/{#SecretParameterName} acs:oos:{#regionId}:{#accountId}:secretparameter/*
OpsItem	acs:oos:{#regionId}:{#accountId}:opsitem/{#OpsItemId} acs:oos:{#regionId}:{#accountId}:opsitem/*
PatchBaseline	acs:oos:{#regionId}:{#accountId}:patchbaseline/{#PatchBaselineName} acs:oos:{#regionId}:{#accountId}:patchbaseline/* acs:oos:{#regionId}:{#accountId}:patchbaseline/{#Name}
Execution	acs:oos:{#regionId}:{#accountId}:execution/{#ExecutionId} acs:oos:{#regionId}:{#accountId}:execution/*
template	acs:oos:{#regionId}:{#accountId}:template/{#templateName}
ServiceSetting	acs:oos:{#regionId}:{#accountId}:ServiceSetting
ApplicationGroup	acs:oos:{#regionId}:{#accountId}:application/{#applicationName}/applicationgroup/{#applicationGroupName} acs:oos:{#regionId}:{#AccountId}:application/{#applicationName}/applicationgroup/*
stateconfiguration	acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#stateconfigurationId}

Condition

The following table lists the product-level condition keys defined by CloudOps Orchestration Service . You can also use Alibaba Cloud's Common condition keys. Specify these keys in the Condition element of RAM policy statements to define granular authorization rules. In the condition key, specify the condition values in the Condition_value element of the policy.

Each condition key has a specific data type, such as string, number, Boolean, or IP address. The data type determines which conditional operators can be used to compare the request values against policy values. You must specify the conditional operators compatible with the data type of the condition key. Mismatched operators will invalidate the policy. See Condition operator for valid combinations.

Condition key	Description	Data type
oos:IsOOSAssumeRole	Whether the OOS StartExecution is called by AssumeRole	Boolean
oos:TLSVersion	TLS version used for OOS OpenAPI calls	String
oos:tag	OOS tag information, it is used in combination with tag key, oos:tag/<tag-key>. Example: Assuming the tag is team:dev, the condition key and its value are \\\\"oos:tag/team\\\\": \\\\"dev\\\\"	String

How to create custom RAM policies?

You can create custom policies and grant them to RAM users, RAM user groups, or RAM roles. For instructions, see: