Modify an authorization rule via ModifyRule - Bastionhost - Alibaba Cloud - Bastionhost

Updates the basic information of an authorization rule.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Bastionhost instance to which the authorization rule to be updated belongs. > You can call the DescribeInstances operation to obtain the value of this parameter.	bastionhost-cn-zmb2y9ydw08
RegionId	string	No	The region ID of the Bastionhost instance to which the authorization rule to be updated belongs. > For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
RuleId	string	Yes	The ID of the authorization rule to be updated.	68
RuleName	string	No	The new name of the authorization rule. The name must be 1 to 128 characters in length and cannot start with a special character. It can contain only periods (.), underscores (_), hyphens (-), single quotation marks ('), and spaces.	test
Comment	string	No	The new remarks for the authorization rule. The remarks can be up to 500 characters in length.	TEST
EffectiveStartTime	integer	No	The new start time of the validity period for the authorization rule. The value is a UNIX timestamp in seconds.	1669630029
EffectiveEndTime	integer	No	The new end time of the validity period for the authorization rule. The value is a UNIX timestamp in seconds.	1672502400
UserIds	array	No	The new list of user IDs associated with the authorization rule.
	string	No	The ID of a user associated with the authorization rule.	1
UserGroupIds	array	No	The new list of user group IDs associated with the authorization rule.
	string	No	The ID of a user group associated with the authorization rule.	1
Hosts	array<object>	No	The new array of host IDs and host account IDs associated with the authorization rule.
	object	No
HostId	string	No	The host ID.	1
HostAccountIds	array	No	The list of host account IDs.
	string	No	The host account ID.	1
Databases	array<object>	No	The new list of database instances and database accounts associated with the authorization rule.
	object	No
DatabaseId	string	No	The database instance ID.	2
DatabaseAccountIds	array	No	The list of database account IDs.
	string	No	The database account ID.	2
HostGroups	array<object>	No	The new list of asset groups and accounts associated with the authorization rule.
	object	No
HostGroupId	string	No	The asset group ID.	1
HostAccountNames	array	No	The list of asset account names.
	string	No	The asset account name.	root
ProjectId	integer	No	The project ID.	3

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique identifier generated by Alibaba Cloud for the request.	67EB57AD-5C83-537B-B2A1-6082798965F0

Examples

Success response

JSON format

{
  "RequestId": "67EB57AD-5C83-537B-B2A1-6082798965F0"
}

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.
404	RuleNotFound	The rule is not found.	The rule is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.