Query commands pending review with ListApproveCommands - Bastionhost - Alibaba Cloud - Bastionhost

Retrieves the list of commands that require approval.

Operation description

This API operation allows administrators to retrieve the list of commands that require approval.

The queries per second (QPS) limit for a single user is 10. If the limit is exceeded, API calls are throttled, which may affect your services. Call this operation as needed.

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 instance ID of the Bastionhost instance. Note You can call the DescribeInstances operation to obtain the value of this parameter.	bastionhost-cn-zvp2xvysf08
RegionId	string	No	The region ID of the Bastionhost instance. Note For more information about the mappings between region IDs and region names, see Regions and zones.	cn-beijing
PageNumber	string	Yes	The page number of the page to return in a paged query. Default value: 1.	1
PageSize	string	Yes	The maximum number of entries to return on each page in a paged query. The maximum value of the PageSize parameter is 1000. Default value: 20. If the PageSize parameter is left empty, 20 entries are returned by default. Note Specify the PageSize parameter.	20
ProjectId	integer	No	The project ID.	3

Response elements

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

Examples

Success response

JSON format

{
  "ApproveCommands": [
    {
      "ApproveCommandId": "1",
      "AssetIp": "10.167.XX.XX",
      "ClientIp": "172.18.XX.XX",
      "ClientUser": "test",
      "Command": "/bin/bash",
      "CreateTime": "1679393152",
      "ProtocolName": "SSH",
      "SessionId": "95f873ab64a76d5b0000000000004d5e",
      "State": "Wait",
      "AssetAccountName": "root",
      "AssetName": "poros-test"
    }
  ],
  "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.