GetPolicyUserScope - Bastionhost - Alibaba Cloud Documentation Center

Queries the scope of users to whom a control policy applies.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
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 key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:GetPolicyUserScope		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host to which the control policy to query belongs. Note You can call the DescribeInstances operation to query the ID of the bastion host.	bastion-xxxx-xx
RegionId	string	No	The region ID of the bastion host to which the control policy to query belongs. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
PolicyId	string	Yes	The ID of the control policy that you want to query. Note You can call the ListPolicies operation to query the control policy ID.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
UserScope	object	The users to whom the control policy applies.
ScopeType	string	The scope of users to whom the control policy applies. If All is returned for this parameter, the control policy applies to all users. If no value is returned for this parameter, the control policy applies to the assets specified in the return values of UserGroupIds and UserIds.	All
UserGroupIds	array	The user groups to which the control policy applies.
item	string	The user group IDs.	["1", "2", "3"]
UserIds	array	The users to whom the control policy applies.
item	string	The user IDs.	["1", "2", "3"]

Examples

Sample success responses

JSONformat

{
  "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.

For a list of error codes, visit the Service error codes.