ListRules - Bastionhost - Alibaba Cloud Documentation Center

Queries a list of authorization rules of a bastion host.

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:ListRules		All Resources ``	none	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 parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Rules	array<object>	The authorization rules that are returned.
item	object
Comment	string	The remarks of the authorization rule.	comment
EffectiveEndTime	long	The end time of the validity period of the authorization rule. The value is a timestamp. Unit: seconds.	1709258400
EffectiveStartTime	long	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	long	The total number of authorization rules that are returned.	1

Examples

Sample success responses

JSONformat

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

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