Check user permissions for resources or pages with the CheckRole API - Cloud Backup - Alibaba Cloud - Cloud Backup

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. 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 supports 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 Alibaba Cloud Resource Name (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 applicable across all RAM-supported services.
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

Access level

Resource type

Condition key

Dependent action

hbr:CheckRole

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CheckRoleType	string	No	The role type. Valid values: EcsRole: access permissions for ECS resources CsgRole: permissions to back up Cloud Storage Gateway resources NasRole: permissions to back up NAS resources OssRole: permissions to back up OSS resources UdmRole: permissions to back up entire ECS instances VMwareLocalRole: permissions to back up on-premises VMware virtual machines VMwareCloudRole: permissions to back up cloud-based VMware virtual machines EcsBackupRole: permissions for ECS backup OtsRole: permissions to back up OTS resources CrossAccountRole: permissions for cross-account backup	OssRole
CrossAccountUserId	integer	No	The ID of the source account for cross-account backup managed by the current account.	158975xxxxx4625
CrossAccountRoleName	string	No	The name of the RAM role created in the source account for cross-account backup managed by the current account.	BackupRole

Response elements

Element	Type	Description	Example
	object
Code	string	The response code. 200 indicates success.	200
Message	string	The response message. "successful" is returned if the request is successful. An error message is returned if the request fails.	successful
RequestId	string	The request ID.	2F63CA9B-744E-51C0-A638-27882BB03078
Success	boolean	Indicates whether the request is successful. true: The request is successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "2F63CA9B-744E-51C0-A638-27882BB03078",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
200	CrossAccountBackupSlrNotExist	AliyunServiceRoleForHbrCrossAccountBackup doesn't exist, please create this role.	AliyunServiceRoleForHbrCrossAccountBackup the role does not exist, create this service association role.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.