Create an authorization rule by using the CreateRule API - Bastionhost - Alibaba Cloud - Bastionhost

Creates an authorization rule to grant multiple users batch access to assets and set the validity period for their access. The authorization rule feature improves the efficiency of managing users and assets, and controls the time period during which users can access assets.

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

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID of the bastion host. Note You can call the DescribeInstances operation to obtain this parameter.	bastionhost-cn-5yd2ymfsa0e
RegionId	string	No	The region ID of the bastion host. Note For the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
RuleName	string	Yes	The name of the authorization rule. Maximum length: 128 characters.	rule
Comment	string	No	The description of the authorization rule. Maximum length: 500 characters.	comment
EffectiveStartTime	integer	No	The start time of the validity period for the authorization rule, in seconds (timestamp format).	1669630029
EffectiveEndTime	integer	No	The end time of the validity period for the authorization rule, in seconds (timestamp format).	1672502400
UserIds	array	No	The array of user IDs.
	string	No	The user ID. Note You can call the ListUsers operation to obtain this parameter.	1
UserGroupIds	array	No	The array of user group IDs.
	string	No	The user group ID. Note You can call the ListUserGroups operation to obtain this parameter.	1
Hosts	array<object>	No	The host information.
	object	No	The host ID and host account ID to authorize.
HostId	string	No	The host ID.	1
HostAccountIds	array	No	The array of host account IDs.
	string	No	The host account ID.	1
Databases	array<object>	No	The database information.
	object	No	The database instance ID and database account ID to authorize.
DatabaseId	string	No	The database instance ID.	2
DatabaseAccountIds	array	No	The array of database account IDs.
	string	No	The database account ID.	4
HostGroups	array<object>	No	The asset group information to authorize.
	object	No	The asset group to authorize.
HostGroupId	string	No	The asset group ID.	3
HostAccountNames	array	No	The array of asset account names.
	string	No	The asset account name.	root
ProjectId	integer	No	The project ID.	3

Hosts array.

Host structure

Field	Type	Description
HostId	string	The host ID.
HostAccountIds	array[string]	The array of host account IDs.

HostGroups array.

HostGroup structure

Field	Type	Description
HostGroupId	string	The host group ID.
HostAccountNames	array[string]	The array of host account names.

AssetGroup structure

Field	Type	Description
AssetGroupId	string	The asset group ID.
AssetAccountNames	array[string]	The array of asset account names.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID generated by Alibaba Cloud for this request.	BFA818E3-0A53-51F4-8DB5-AF2A62A6D042
RuleId	string	The authorization rule ID.	1

Examples

Success response

JSON format

{
  "RequestId": "BFA818E3-0A53-51F4-8DB5-AF2A62A6D042",
  "RuleId": "1"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
400	RuleAlreadyExists	The rule already exists.	The rule already exists.
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.