Use SetPolicyAssetScope to specify the asset scope for a control policy - Bastionhost - Alibaba Cloud - Bastionhost

Sets the effective asset scope for a specified control policy.

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:SetPolicyAssetScope

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The Bastionhost instance ID. Note You can invoke the DescribeInstances operation to obtain this parameter.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the Bastionhost instance. 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 modify. Note You can call the ListPolicies operation to obtain this parameter.	7
ScopeType	string	Yes	The scope of assets to which the control policy applies. Valid values: All: all assets Host: selected hosts Database: selected databases HostGroup: selected asset groups	All
Hosts	array<object>	No	The scope of hosts to which the control policy applies. Note Required when ScopeType is set to Host. You can specify up to 500 hosts.
	object	No
HostId	string	No	The ID of the host.	1
AccountScopeType	string	No	The scope of host accounts to which the control policy applies. Valid values: All: all accounts on the host AccountId: specified accounts on the host	All
HostAccountIds	array	No	The scope of host accounts to which the control policy applies. Note Required when AccountScopeType is set to AccountId.
	string	No	The ID of the host account.	["96"]
Databases	array<object>	No	The scope of database assets to which the control policy applies. Note Required when ScopeType is set to Database. You can specify up to 500 databases.
	object	No
DatabaseId	string	No	The database instance ID.	3
AccountScopeType	string	No	The scope of database accounts to which the control policy applies. Valid values: All: all accounts in the database AccountId: specified accounts in the database	AccountId
DatabaseAccountIds	array	No	The scope of database accounts to which the control policy applies. Note Required when AccountScopeType is set to AccountId.
	string	No	The ID of the database account.	["3"]
HostGroups	array<object>	No	The scope of asset groups to which the control policy applies. Note Required when ScopeType is set to HostGroup. You can specify up to 100 asset groups.
	object	No
HostGroupId	string	No	The ID of the asset group.	86
AccountScopeType	string	No	The scope of asset accounts to which the control policy applies. Valid values: All: all accounts in the asset group AccountName: specified accounts in the asset group	All
AccountNames	array	No	The scope of asset accounts to which the control policy applies. Note Required when AccountScopeType is set to AccountNames.
	string	No	The name of the asset account.	["root", "admin"]
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	5EAB922E-F476-5DFA-9290-313C608E724B

Examples

Success response

JSON format

{
  "RequestId": "5EAB922E-F476-5DFA-9290-313C608E724B"
}

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.
404	PolicyNotFound	The policy is not found.	The policy is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.