All Products
Search
Document Center

Cloud Backup:RAM authorization

Last Updated:Jan 02, 2025
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 HBR. You can use the elements to create policies in RAM. The code (RamCode) in RAM that is used to indicate HBR is [{"popCode":"hbr-inner","ramCodes":["hbr-inner"]},{"popCode":"hbr","ramCodes":["hbr"]}]. You can grant permissions on HBR 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

HBR 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
hbr:GenerateRamPolicyGenerateRamPolicynone
All Resources
*
NoneNone
hbr:UpdateVaultUpdateVaultupdate
All Resources
*
NoneNone
hbr:CreatePolicyV2CreatePolicyV2create
All Resources
*
NoneNone
hbr:StopHanaDatabaseAsyncStopHanaDatabaseAsyncupdate
All Resources
*
NoneNone
hbr:DescribePoliciesV2DescribePoliciesV2list
All Resources
*
NoneNone
hbr:UpdatePolicyBindingUpdatePolicyBindingupdate
All Resources
*
NoneNone
hbr:DescribeBackupPlansDescribeBackupPlansget
All Resources
*
NoneNone
hbr:UpgradeBackupClientsUpgradeBackupClients
All Resources
*
NoneNone
hbr:DescribeHanaRetentionSettingDescribeHanaRetentionSettingget
All Resources
*
NoneNone
hbr:CreateClientsCreateClientscreate
All Resources
*
NoneNone
hbr:DeleteBackupClientResourceDeleteBackupClientResourcedelete
All Resources
*
NoneNone
hbr:CreateHanaInstanceCreateHanaInstancecreate
All Resources
*
NoneNone
hbr:UpdateClientSettingsUpdateClientSettingsupdate
All Resources
*
NoneNone
hbr:CreateRestoreJobCreateRestoreJobcreate
All Resources
*
NoneNone
hbr:UninstallBackupClientsUninstallBackupClients
All Resources
*
NoneNone
hbr:DescribeHanaInstancesDescribeHanaInstancesget
All Resources
*
NoneNone
hbr:CreateHanaBackupPlanCreateHanaBackupPlancreate
All Resources
*
NoneNone
hbr:DescribeHanaBackupPlansDescribeHanaBackupPlansget
All Resources
*
NoneNone
hbr:SearchHistoricalSnapshotsSearchHistoricalSnapshotsget
All Resources
*
NoneNone
hbr:EnableHanaBackupPlanEnableHanaBackupPlanupdate
All Resources
*
NoneNone
hbr:UpdateHanaBackupSettingUpdateHanaBackupSettingupdate
All Resources
*
NoneNone
hbr:CreateReplicationVaultCreateReplicationVaultcreate
All Resources
*
NoneNone
hbr:DeletePolicyBindingDeletePolicyBinding
All Resources
*
NoneNone
hbr:DeletePolicyV2DeletePolicyV2
All Resources
*
NoneNone
hbr:CreateHanaRestoreCreateHanaRestorecreate
All Resources
*
NoneNone
hbr:DescribeUdmSnapshotsDescribeUdmSnapshotslist
All Resources
*
NoneNone
hbr:DescribeCrossAccountsDescribeCrossAccounts
All Resources
*
NoneNone
hbr:DeleteHanaInstanceDeleteHanaInstancedelete
All Resources
*
NoneNone
hbr:DeleteAirEcsInstanceDeleteAirEcsInstancedelete
All Resources
*
NoneNone
hbr:CreateVaultCreateVaultcreate
All Resources
*
NoneNone
hbr:DescribeHanaDatabasesDescribeHanaDatabasesget
All Resources
*
NoneNone
hbr:DescribeBackupJobs2DescribeBackupJobs2get
All Resources
*
NoneNone
hbr:UpgradeClientUpgradeClientupdate
All Resources
*
NoneNone
hbr:UpdatePolicyV2UpdatePolicyV2update
All Resources
*
NoneNone
hbr:DeleteUdmDiskDeleteUdmDiskdelete
All Resources
*
NoneNone
hbr:DescribeVaultsDescribeVaultsget
All Resources
*
NoneNone
hbr:CreatePolicyBindingsCreatePolicyBindingscreate
All Resources
*
NoneNone
hbr:UpdateHanaBackupPlanUpdateHanaBackupPlanupdate
All Resources
*
NoneNone
hbr:DetachNasFileSystemDetachNasFileSystem
All Resources
*
NoneNone
hbr:DescribeContainerClusterDescribeContainerClusterget
All Resources
*
NoneNone
hbr:UpdateContainerClusterUpdateContainerClusterupdate
All Resources
*
NoneNone
hbr:DisableHanaBackupPlanDisableHanaBackupPlanupdate
All Resources
*
NoneNone
hbr:DescribeRestoreJobs2DescribeRestoreJobs2get
All Resources
*
NoneNone
hbr:DeleteSnapshotDeleteSnapshotdelete
All Resources
*
NoneNone
hbr:ExecuteBackupPlanExecuteBackupPlancreate
All Resources
*
NoneNone
hbr:UpdateHanaInstanceUpdateHanaInstanceupdate
All Resources
*
NoneNone
hbr:UpdateHanaRetentionSettingUpdateHanaRetentionSettingupdate
All Resources
*
NoneNone
hbr:DescribePolicyBindingsDescribePolicyBindingslist
All Resources
*
NoneNone
hbr:ChangeResourceGroupChangeResourceGroup
All Resources
*
NoneNone
hbr:CreateBackupPlanCreateBackupPlancreate
All Resources
*
NoneNone
hbr:GetTempFileDownloadLinkGetTempFileDownloadLinkget
All Resources
*
NoneNone
hbr:DescribeBackupClientsDescribeBackupClientsget
All Resources
*
NoneNone
hbr:CreateBackupJobCreateBackupJobcreate
All Resources
*
NoneNone
hbr:DeleteClientDeleteClientdelete
All Resources
*
NoneNone
hbr:DeleteVaultDeleteVaultdelete
All Resources
*
NoneNone
hbr:CheckRoleCheckRolenone
All Resources
*
NoneNone
hbr:DeleteBackupPlanDeleteBackupPlandelete
All Resources
*
NoneNone
hbr:DeleteHanaBackupPlanDeleteHanaBackupPlandelete
All Resources
*
NoneNone
hbr:UpdateBackupPlanUpdateBackupPlanupdate
All Resources
*
NoneNone
hbr:DeleteBackupClientDeleteBackupClientdelete
All Resources
*
NoneNone
hbr:ExecutePolicyV2ExecutePolicyV2
All Resources
*
NoneNone
hbr:StartHanaDatabaseAsyncStartHanaDatabaseAsyncupdate
All Resources
*
NoneNone
hbr:UninstallClientUninstallClientdelete
All Resources
*
NoneNone
hbr:DescribeHanaRestoresDescribeHanaRestoresget
All Resources
*
NoneNone
hbr:CancelRestoreJobCancelRestoreJobupdate
All Resources
*
NoneNone
hbr:DescribeClientsDescribeClientsget
All Resources
*
NoneNone
hbr:DescribeOtsTableSnapshotsDescribeOtsTableSnapshotsget
All Resources
*
NoneNone
hbr:DescribeHanaBackupSettingDescribeHanaBackupSettingget
All Resources
*
NoneNone
hbr:AddContainerClusterAddContainerClustercreate
All Resources
*
NoneNone
hbr:DeleteUdmEcsInstanceDeleteUdmEcsInstance
All Resources
*
NoneNone
hbr:DescribeHanaBackupsAsyncDescribeHanaBackupsAsyncget
All Resources
*
NoneNone
hbr:DisableBackupPlanDisableBackupPlanupdate
All Resources
*
NoneNone
hbr:EnableBackupPlanEnableBackupPlanupdate
All Resources
*
NoneNone
hbr:DescribeTaskDescribeTaskget
All Resources
*
NoneNone
hbr:CreateTempFileUploadUrlCreateTempFileUploadUrl
All Resources
*
NoneNone
hbr:CancelBackupJobCancelBackupJobdelete
All Resources
*
NoneNone
hbr:DescribeRecoverableOtsInstancesDescribeRecoverableOtsInstancesget
All Resources
*
NoneNone
hbr:OpenHbrServiceOpenHbrServicecreate
All Resources
*
NoneNone
hbr:InstallBackupClientsInstallBackupClients
All Resources
*
NoneNone

Resource

HBR 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
No data

Condition

HBR 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: