Call GetPolicyUserScope to query the user scope of a control policy - Bastionhost - Alibaba Cloud - Bastionhost

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

yundun-bastionhost:GetPolicyUserScope

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the bastion host to which the control policy belongs. Note You can invoke the DescribeInstances operation to obtain this parameter.	bastion-xxxx-xx
RegionId	string	No	The region ID of the bastion host instance to which the control policy belongs. Note For the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
PolicyId	string	Yes	The ID of the control policy to query. Note You can call the ListPolicies operation to obtain this parameter.	1
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID generated by Alibaba Cloud for this request.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
UserScope	object	The effective user scope of the control policy.
ScopeType	string	The effective user scope of the control policy. Note If All is returned, the policy applies to all users. If an empty value is returned, the policy applies to specified users. The specific scope is indicated by the values of UserGroupIds and UserIds.	All
UserGroupIds	array	The user groups to which the control policy applies.
	string	The user group ID.	["1", "2", "3"]
UserIds	array	The effective user scope of the control policy.
	string	The user ID.	["1", "2", "3"]

Examples

Success response

JSON format

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "UserScope": {
    "ScopeType": "All",
    "UserGroupIds": [
      "[\"1\", \"2\", \"3\"]"
    ],
    "UserIds": [
      "[\"1\", \"2\", \"3\"]"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
500	InternalError	An unknown error occurred.	An unknown error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.