ListRules - Bastionhost - Alibaba Cloud Documentation Center

Queries a list of authorization rules of a bastion host.

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

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The bastion host ID. Note You can call the DescribeInstances operation to query the bastion host ID.	bastionhost-cn-5yd34ol020a
RegionId	string	No	The region ID of the bastion host. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
PageNumber	string	No	The page number. Default value: 1.	1
PageSize	string	No	The number of entries per page. Valid values: 1 to 100. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. Note We recommend that you do not leave this parameter empty.	20
RuleName	string	No	The name of the authorization rule to query. Only exact match is supported.	rule
RuleState	string	No	The state of the authorization rule to query. Enabled Disabled	Enabled

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Rules	array<object>	The authorization rules that are returned.
	object
Comment	string	The remarks of the authorization rule.	comment
EffectiveEndTime	integer	The end time of the validity period of the authorization rule. The value is a timestamp. Unit: seconds.	1709258400
EffectiveStartTime	integer	The start time of the validity period of the authorization rule. The value is a timestamp. Unit: seconds.	1685499134
RuleId	string	The authorization rule ID.	13
RuleName	string	The name of the authorization rule.	rule
RuleState	string	The state of the authorization rule. Enabled Disabled	Enabled
TotalCount	integer	The total number of authorization rules that are returned.	1

Examples

Success response

JSON format

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Rules": [
    {
      "Comment": "comment",
      "EffectiveEndTime": 1709258400,
      "EffectiveStartTime": 1685499134,
      "RuleId": "13",
      "RuleName": "rule",
      "RuleState": "Enabled"
    }
  ],
  "TotalCount": 1
}

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.