GetPermission - Resource Management - Alibaba Cloud Documentation Center

Queries the information about a permission.

Operation description

This topic provides an example on how to call the API operation to query the information about the AliyunRSDefaultPermissionVSwitch permission whose version is v1 in the cn-hangzhou region.

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

resourcesharing:GetPermission

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PermissionName	string	Yes	The name of the permission.	AliyunRSDefaultPermissionVSwitch
PermissionVersion	string	No	The version of the permission.	v1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA
Permission	object	The information about the permission.
PermissionName	string	The name of the permission.	AliyunRSDefaultPermissionVSwitch
PermissionVersion	string	The version of the permission.	v1
Permission	string	The document of the policy related to the permission.	{"Effect":"Allow","Action":["vpc:DescribeVSwitches","vpc:DescribeVSwitchAttributes"]}
ResourceType	string	The type of the shared resources. For more information about the types of resources that can be shared, see Services that work with Resource Sharing.	VSwitch
DefaultVersion	boolean	Indicates whether the version is the default version. Valid values: false: The version is not the default version. true: The version is the default version.	true
CreateTime	string	The creation time.	2020-12-07T07:39:01.818Z
UpdateTime	string	The update time.	2020-12-07T07:39:01.818Z
DefaultPermission	boolean	Indicates whether the permission is the default permission. Valid values: false: The permission is not the default permission. true: The permission is the default permission.	true

Examples

Success response

JSON format

{
  "RequestId": "2F23CFB6-A721-4E90-AC1E-0E30FA8B45DA",
  "Permission": {
    "PermissionName": "AliyunRSDefaultPermissionVSwitch",
    "PermissionVersion": "v1",
    "Permission": "{\"Effect\":\"Allow\",\"Action\":[\"vpc:DescribeVSwitches\",\"vpc:DescribeVSwitchAttributes\"]}",
    "ResourceType": "VSwitch",
    "DefaultVersion": true,
    "CreateTime": "2020-12-07T07:39:01.818Z",
    "UpdateTime": "2020-12-07T07:39:01.818Z",
    "DefaultPermission": true
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.PermissionVersion	The PermissionVersion is invalid.	The value of PermissionVersion is invalid.
400	MissingParameter.PermissionName	You must specify PermissionName.	PermissionName is not configured.
404	EntityNotExists.Permission	The resource share permission does not exist.	You do not have the required permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.