RAM authorization - Cloud Backup - 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 Cloud Backup for RAM permission policies. The RAM code (RamCode) for Cloud Backup is hbr , and the supported authorization granularity is OPERATION .

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 Cloud Backup. 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
hbr:ExecutePolicyV2	ExecutePolicyV2	create	All Resource ``	None	None
hbr:DescribeClients	DescribeClients	get	All Resource ``	None	None
hbr:DeletePolicyV2	DeletePolicyV2		All Resource ``	None	None
hbr:DescribeRestoreJobs2	DescribeRestoreJobs2	get	All Resource ``	None	None
hbr:CreateClients	CreateClients	create	All Resource ``	None	None
hbr:UpgradeBackupClients	UpgradeBackupClients	update	All Resource ``	None	None
hbr:DeleteAirEcsInstance	DeleteAirEcsInstance	delete	All Resource ``	None	None
hbr:UpdateClientSettings	UpdateClientSettings	update	All Resource ``	None	None
hbr:CheckRole	CheckRole	none	All Resource ``	None	None
hbr:DescribeRecoverableOtsInstances	DescribeRecoverableOtsInstances	get	All Resource ``	None	None
hbr:DescribeOtsTableSnapshots	DescribeOtsTableSnapshots	get	All Resource ``	None	None
hbr:CancelBackupJob	CancelBackupJob	delete	All Resource ``	None	None
hbr:UpdatePolicyV2	UpdatePolicyV2	update	All Resource ``	None	None
hbr:StartHanaDatabaseAsync	StartHanaDatabaseAsync	update	All Resource ``	None	None
hbr:DescribeBackupPlans	DescribeBackupPlans	get	All Resource ``	None	None
hbr:UpdateHanaInstance	UpdateHanaInstance	update	All Resource ``	None	None
hbr:DeleteHanaInstance	DeleteHanaInstance	delete	All Resource ``	None	None
hbr:DescribeUdmSnapshots	DescribeUdmSnapshots	list	All Resource ``	None	None
hbr:DescribeHanaRetentionSetting	DescribeHanaRetentionSetting	get	All Resource ``	None	None
hbr:DescribeHanaBackupPlans	DescribeHanaBackupPlans	get	All Resource ``	None	None
hbr:DeleteUdmEcsInstance	DeleteUdmEcsInstance	delete	All Resource ``	None	None
hbr:ListProtectedResources	ListProtectedResources	list	All Resource ``	None	None
hbr:UpdateVault	UpdateVault	update	All Resource ``	None	None
hbr:DescribeBackupClients	DescribeBackupClients	get	All Resource ``	None	None
hbr:DescribePoliciesV2	DescribePoliciesV2	list	All Resource ``	None	None
hbr:ExecuteBackupPlan	ExecuteBackupPlan	create	All Resource ``	None	None
hbr:CreateHanaInstance	CreateHanaInstance	create	All Resource ``	None	None
hbr:DisableHanaBackupPlan	DisableHanaBackupPlan	update	All Resource ``	None	None
hbr:DescribeContainerCluster	DescribeContainerCluster	get	All Resource ``	None	None
hbr:DeleteSnapshot	DeleteSnapshot	delete	All Resource ``	None	None
hbr:CreateBackupPlan	CreateBackupPlan	create	All Resource ``	None	None
hbr:DeletePolicyBinding	DeletePolicyBinding		All Resource ``	None	None
hbr:CreateReplicationVault	CreateReplicationVault	create	All Resource ``	None	None
hbr:DescribeHanaRestores	DescribeHanaRestores	get	All Resource ``	None	None
hbr:DeleteClient	DeleteClient	delete	All Resource ``	None	None
hbr:CreateHanaRestore	CreateHanaRestore	create	All Resource ``	None	None
hbr:DescribeHanaInstances	DescribeHanaInstances	get	All Resource ``	None	None
hbr:EnableHanaBackupPlan	EnableHanaBackupPlan	update	All Resource ``	None	None
hbr:CreateHanaBackupPlan	CreateHanaBackupPlan	create	All Resource ``	None	None
hbr:UpdateHanaRetentionSetting	UpdateHanaRetentionSetting	update	All Resource ``	None	None
hbr:CreateTempFileUploadUrl	CreateTempFileUploadUrl	create	All Resource ``	None	None
hbr:CreatePolicyBindings	CreatePolicyBindings	create	All Resource ``	None	None
hbr:StopHanaDatabaseAsync	StopHanaDatabaseAsync	update	All Resource ``	None	None
hbr:ChangeResourceGroup	ChangeResourceGroup	update	All Resource ``	None	None
hbr:DescribeHanaBackupsAsync	DescribeHanaBackupsAsync	get	All Resource ``	None	None
hbr:CreatePolicyV2	CreatePolicyV2	create	All Resource ``	None	None
hbr:UpdateHanaBackupPlan	UpdateHanaBackupPlan	update	All Resource ``	None	None
hbr:DescribeHanaBackupSetting	DescribeHanaBackupSetting	get	All Resource ``	None	None
hbr:GenerateRamPolicy	GenerateRamPolicy	none	All Resource ``	None	None
hbr:InstallBackupClients	InstallBackupClients	update	All Resource ``	None	None
hbr:CreateVault	CreateVault	create	All Resource ``	None	None
hbr:UpdateBackupPlan	UpdateBackupPlan	update	All Resource ``	None	None
hbr:CreateRestoreJob	CreateRestoreJob	create	All Resource ``	None	None
hbr:DetachNasFileSystem	DetachNasFileSystem	update	All Resource ``	None	None
hbr:DeleteUdmDisk	DeleteUdmDisk	delete	All Resource ``	None	None
hbr:DescribePolicyBindings	DescribePolicyBindings	list	All Resource ``	None	None
hbr:SearchHistoricalSnapshots	SearchHistoricalSnapshots	get	All Resource ``	None	None
hbr:CreateBackupJob	CreateBackupJob	create	All Resource ``	None	None
hbr:DescribeBackupJobs2	DescribeBackupJobs2	get	All Resource ``	None	None
hbr:UninstallClient	UninstallClient	delete	All Resource ``	None	None
hbr:DeleteBackupClientResource	DeleteBackupClientResource	delete	All Resource ``	None	None
hbr:UpdateHanaBackupSetting	UpdateHanaBackupSetting	update	All Resource ``	None	None
hbr:DeleteBackupPlan	DeleteBackupPlan	delete	All Resource ``	None	None
hbr:CancelRestoreJob	CancelRestoreJob	update	All Resource ``	None	None
hbr:UninstallBackupClients	UninstallBackupClients	update	All Resource ``	None	None
hbr:GetTempFileDownloadLink	GetTempFileDownloadLink	get	All Resource ``	None	None
hbr:DescribeHanaDatabases	DescribeHanaDatabases	get	All Resource ``	None	None
hbr:OpenHbrService	OpenHbrService	create	All Resource ``	None	None
hbr:UpgradeClient	UpgradeClient	update	All Resource ``	None	None
hbr:DeleteBackupClient	DeleteBackupClient	delete	All Resource ``	None	None
hbr:DeleteHanaBackupPlan	DeleteHanaBackupPlan	delete	All Resource ``	None	None
hbr:UpdatePolicyBinding	UpdatePolicyBinding	update	All Resource ``	None	None
hbr:DescribeCrossAccounts	DescribeCrossAccounts	list	All Resource ``	None	None
hbr:AddContainerCluster	AddContainerCluster	create	All Resource ``	None	None
hbr:DisableBackupPlan	DisableBackupPlan	update	All Resource ``	None	None
hbr:DescribeVaults	DescribeVaults	get	All Resource ``	None	None
hbr:EnableBackupPlan	EnableBackupPlan	update	All Resource ``	None	None
hbr:DescribeTask	DescribeTask	get	All Resource ``	None	None
hbr:UpdateContainerCluster	UpdateContainerCluster	update	All Resource ``	None	None
hbr:DeleteVault	DeleteVault	delete	All Resource ``	None	None

Resource

The following table lists the resources defined by Cloud Backup. 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

Condition

Cloud Backup does not define product-level condition keys. However, you can use Alibaba Cloud common condition keys for access control. For more information, see Common condition keys.

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: