GetAbacPolicy - Query ABAC permission policy details | DMS API - Data Management

Queries the details of an ABAC permission policy, including its name, content, and creator.

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

dms:GetAbacPolicy

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AbacPolicyId	integer	No	The ID of the policy.	12****
AbacPolicyName	string	No	The name of the policy.	policy_test
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, log on to the DMS console and hover over the profile icon in the upper-right corner. View information about the current tenant.	3***

Response elements

Element	Type	Description	Example
	object	Response schema.
RequestId	string	The request ID, used to query logs and troubleshoot issues.	2B7844DE-A0C3-50ED-A796-8F07D377144C
ErrorCode	string	The error code returned on failure.	UnknownError
ErrorMessage	string	The error message returned on failure.	UnknownError
Success	boolean	Whether the request succeeded. Valid values: true: The request succeeded. false: The request failed.	true
Policy	object	The details of the policy.
PolicyName	string	The name of the policy.	policy_test
PolicyDesc	string	The description of the policy.	test
PolicyContent	string	The content of the policy.	{ "Statement": [ { "Action": "", "Effect": "Allow", "Resource": "", "Condition": { "StringEqualsIgnoreCase": { "dms:DbType": [ "redis" ] } } } ], "Version": "1" }
CreatorId	integer	The ID of the user who created the policy.	51****
PolicySource	string	The source of the policy. Valid values:	自定义
AuthorizedQuantity	string	The number of users or custom roles attached to this policy.	3
PolicyId	integer	The ID of the policy.	12****

Examples

Success response

JSON format

{
  "RequestId": "2B7844DE-A0C3-50ED-A796-8F07D377144C",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Policy": {
    "PolicyName": "policy_test",
    "PolicyDesc": "test",
    "PolicyContent": "{\n  \"Statement\": [\n    {\n      \"Action\": \"*\",\n      \"Effect\": \"Allow\",\n      \"Resource\": \"*\",\n      \"Condition\": {\n        \"StringEqualsIgnoreCase\": {\n          \"dms:DbType\": [\n            \"redis\"\n          ]\n        }\n      }\n    }\n  ],\n  \"Version\": \"1\"\n}",
    "CreatorId": 0,
    "PolicySource": "自定义",
    "AuthorizedQuantity": "3",
    "PolicyId": 0
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.