ListApproveCommands - Bastionhost - Alibaba Cloud Documentation Center

Queries commands to be reviewed.

Operation description

You can call this operation to query commands to be reviewed by a Bastionhost administrator.

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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

get

*Instance

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host. Note You can call the DescribeInstances operation to query the ID of the bastion host.	bastionhost-cn-zvp2xvysf08
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-beijing
PageNumber	string	Yes	The number of the page. Default value: 1.	1
PageSize	string	Yes	The number of entries per page. Maximum value: 1000. 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

Response elements

Element	Type	Description	Example
	object	The returned data.
ApproveCommands	array<object>	The commands to be reviewed.
	object	The returned data.
ApproveCommandId	string	The ID of the command to be reviewed.	1
AssetAccountName	string	The username of the asset account that is used for O&M.	root
AssetIp	string	The IP address of the asset for O&M.	10.167.XX.XX
AssetName	string	The name of the asset.	poros-test
ClientIp	string	The source IP address from which the application is submitted.	172.18.XX.XX
ClientUser	string	The Bastionhost user who submitted the O&M application.	test
Command	string	The command to be reviewed.	/bin/bash
CreateTime	string	The time when the O&M application was submitted. The value is a UNIX timestamp. Unit: seconds.	1679393152
ProtocolName	string	The O&M protocol.	SSH
SessionId	string	The ID of the O&M session that triggered the review.	95f873ab64a76d5b0000000000004d5e
State	string	The status of the review. Valid values: Wait: The command is pending review.	Wait
RequestId	string	The request ID.	E3EF7711-766D-5888-997B-EFBA76809229
TotalCount	integer	The total number of commands to be reviewed.	15

Examples

Success response

JSON format

{
  "ApproveCommands": [
    {
      "ApproveCommandId": "1",
      "AssetAccountName": "root",
      "AssetIp": "10.167.XX.XX",
      "AssetName": "poros-test",
      "ClientIp": "172.18.XX.XX",
      "ClientUser": "test",
      "Command": "/bin/bash",
      "CreateTime": "1679393152",
      "ProtocolName": "SSH",
      "SessionId": "95f873ab64a76d5b0000000000004d5e",
      "State": "Wait"
    }
  ],
  "RequestId": "E3EF7711-766D-5888-997B-EFBA76809229",
  "TotalCount": 15
}

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.