RAM authorization - OpenSearch - Alibaba Cloud Documentation Center

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 SearchEngine. You can use the elements to create policies in RAM. The code (RamCode) in RAM that is used to indicate SearchEngine is searchengine. You can grant permissions on SearchEngine 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

SearchEngine 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.

Actions	API operation	Access level	Resource type	Condition key	Associated operation
searchengine:GetIndexOnlineStrategy	GetIndexOnlineStrategy	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:GetDataSourceDeploy	GetDataSourceDeploy	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:PushDocuments	PushDocuments		Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:BuildIndex	BuildIndex	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:CreateConfigDir	CreateConfigDir		Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteConfigDir	DeleteConfigDir		Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListInstanceSpecs	ListInstanceSpecs	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:GetDeployGraph	GetDeployGraph	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyOnlineConfig	ModifyOnlineConfig	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyIndexPartition	ModifyIndexPartition	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:PublishIndexVersion	PublishIndexVersion	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListIndexRecoverRecords	ListIndexRecoverRecords	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:StartIndex	StartIndex	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteSqlInstance	DeleteSqlInstance	delete	SqlInstance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteFolder	DeleteFolder	delete	Folder acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeletePublicUrl	DeletePublicUrl	delete	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:CreateTable	CreateTable	create	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteConfigFile	DeleteConfigFile		Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ChangeResourceGroup	ChangeResourceGroup	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListVectorQueryResult	ListVectorQueryResult	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListAdvanceConfigDir	ListAdvanceConfigDir	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:ListTables	ListTables	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:UpdateInstance	UpdateInstance	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteAlias	DeleteAlias	delete	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListOnlineConfigs	ListOnlineConfigs	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:CreateDataSource	CreateDataSource	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListSchemas	ListSchemas	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListDataSourceSchemas	ListDataSourceSchemas	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:GetNodeConfig	GetNodeConfig	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListDataSourceTasks	ListDataSourceTasks	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteInstance	DeleteInstance	delete	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:GetClusterRunTimeInfo	GetClusterRunTimeInfo	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListPostQueryResult	ListPostQueryResult	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyNodeConfig	ModifyNodeConfig	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:CreateIndex	CreateIndex	create	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:RemoveCluster	RemoveCluster	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyIndexOnlineStrategy	ModifyIndexOnlineStrategy	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:StopTask	StopTask	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:GetTableGeneration	GetTableGeneration	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListQueryResult	ListQueryResult	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListClusterNames	ListClusterNames	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:GetIndexVersion	GetIndexVersion	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyPausePolicy	ModifyPausePolicy	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyAdvanceConfig	ModifyAdvanceConfig	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListClusters	ListClusters	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:GetDataSource	GetDataSource	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListAliases	ListAliases	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyTable	ModifyTable	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListDataSources	ListDataSources	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyIndexVersion	ModifyIndexVersion	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ForceSwitch	ForceSwitch	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyPassword	ModifyPassword	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyDataSourceDeploy	ModifyDataSourceDeploy	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:CreateAlias	CreateAlias	create	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:GetIndex	GetIndex	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListTableGenerations	ListTableGenerations	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:CreateInstance	CreateInstance	create	Instance acs:searchengine:{#regionId}:{#accountId}:instance/*	None	None
searchengine:GetCluster	GetCluster	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyClusterOfflineConfig	ModifyClusterOfflineConfig	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:CreateConfigFile	CreateConfigFile		Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteTable	DeleteTable	delete	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyClusterDesc	ModifyClusterDesc	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyFile	ModifyFile	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListInstances	ListInstances	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/*	None	None
searchengine:ListClusterTasks	ListClusterTasks	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:CreateFolder	CreateFolder	create	Folder acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListLogs	ListLogs	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListRestQueryResult	ListRestQueryResult	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteDataSource	DeleteDataSource	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:Reindex	Reindex	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListDateSourceGenerations	ListDateSourceGenerations	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:ListIndexes	ListIndexes	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListAdvanceConfigs	ListAdvanceConfigs	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:GetFile	GetFile	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteIndexVersion	DeleteIndexVersion	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:CreatePublicUrl	CreatePublicUrl	create	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:StopIndex	StopIndex	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:GetAdvanceConfig	GetAdvanceConfig	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:CreateCluster	CreateCluster	create	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyClusterOnlineConfig	ModifyClusterOnlineConfig	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	None	None
searchengine:ModifyAlias	ModifyAlias	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:RecoverIndex	RecoverIndex	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteAdvanceConfig	DeleteAdvanceConfig	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:DeleteIndex	DeleteIndex	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:GetInstance	GetInstance	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyIndex	ModifyIndex	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:PublishAdvanceConfig	PublishAdvanceConfig	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListPausePolicys	ListPausePolicys	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:GetTable	GetTable	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:GetAdvanceConfigFile	GetAdvanceConfigFile	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyAdvanceConfigFile	ModifyAdvanceConfigFile	Write	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ListTasks	ListTasks	none	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None
searchengine:ModifyPublicUrlIpList	ModifyPublicUrlIpList	update	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	None	None

Resource

SearchEngine 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 type	ARN
Instance	acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}
Instance	acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
SqlInstance	acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
Folder	acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
Instance	acs:searchengine:{#regionId}:{#accountId}:instance/*

Condition

SearchEngine does not define service-specific condition keys. For more information about common condition keys that are defined by Alibaba Cloud, see Generic Condition Keyword.

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: