The following tables list the API operations available for use in Bastionhost.
Bastionhost provides the following types of API operations:
- Bastion hosts (available only for bastion hosts that run V3.2.X)
- Tags (available only for bastion hosts that run V3.2.X)
- Regions (available only for bastion hosts that run V3.2.X)
- Hosts (available only for bastion hosts that run V3.2.17)
- Hosts (available only for bastion hosts that run V3.2.17)
- Host accounts (available only for bastion hosts that run V3.2.17)
- Users (available only for bastion hosts that run V3.2.17)
- User groups (available only for bastion hosts that run V3.2.17)
- Host authorization (available only for bastion hosts that run V3.2.17)
Purchase of bastion hosts
| Operation | Description |
|---|---|
| CreateInstance | Bastionhost does not provide an API operation to create a bastion host. To create a bastion host, you can call the CreateInstance operation of the transactions and bills management API to create a bastion host. This API is called BSS API for short. |
| ModifyInstance | Bastionhost does not provide an API operation to modify the specifications of a bastion host. To modify the specifications of a bastion host, you can call the ModifyInstance operation of the BSS API. |
| RenewInstance | Bastionhost does not provide an API operation to renew a bastion host. To renew a bastion host, you can call the RenewInstance operation of the BSS API. |
| SetRenewal | Bastionhost does not provide an API operation to configure auto-renewal for a bastion host. To configure auto-renewal for a bastion host, you can call the SetRenewal operation of the BSS API. |
Bastion hosts (available only for bastion hosts that run V3.2.X)
| Operation | Description |
|---|---|
| DescribeInstanceAttribute | Queries the details of a specified bastion host. |
| DescribeInstances | Queries bastion hosts. |
| ConfigInstanceSecurityGroups | Configures security groups for a specified bastion host. |
| ConfigInstanceWhiteList | Configures a whitelist of public IP addresses for a specified bastion host. |
| StartInstance | Starts a specified bastion host. |
| EnableInstancePublicAccess | Enables Internet access to a specified bastion host. |
| DisableInstancePublicAccess | Disables Internet access to a specified bastion host. |
| ModifyInstanceAttribute | Modifies the information about a specified bastion host. |
| MoveResourceGroup | Moves a specified bastion host from one resource group to another resource group. |
Tags (available only for bastion hosts that run V3.2.X)
| Operation | Description |
|---|---|
| ListTagKeys | Queries the tags that are added to bastion hosts. |
| ListTagResources | Queries the tags that are added to one or more bastion hosts. |
| UntagResources | Removes the tags from specified bastion hosts and deletes the tags at a time. |
| TagResources | Creates and adds tags to specified bastion hosts. |
Regions (available only for bastion hosts that run V3.2.X)
| Operation | Description |
|---|---|
| DescribeRegions | Queries the regions in which you can create bastion hosts. |
Hosts (available only for bastion hosts that run V3.2.17)
| Operation | Description |
|---|---|
| CreateHost | Creates a host for O&M in a specified bastion host. |
| GetHost | Queries the details of a specified host. |
| ListHosts | Queries the hosts in a specified bastion host. |
| DeleteHost | Deletes a specified host. |
| ModifyHostsPort | Changes the service port of one or more hosts. |
| ModifyHostsActiveAddressType | Changes the endpoint type of one or more hosts for O&M. |
| ModifyHost | Modifies the basic information about a specified host. |
Hosts (available only for bastion hosts that run V3.2.17)
| Operation | Description |
|---|---|
| CreateHostGroup | Creates a host group. |
| GetHostGroup | Queries the details of a specified host group. |
| ListHostGroups | Queries the host groups in a specified bastion host. |
| ModifyHostGroup | Modifies the name or description of a specified host group. |
| DeleteHostGroup | Deletes a specified host group. |
| AddHostsToGroup | Adds one or more hosts to a specified host group. |
| RemoveHostsFromGroup | Removes one or more hosts from a specified host group. |
Host accounts (available only for bastion hosts that run V3.2.17)
| Operation | Description |
|---|---|
| CreateHostAccount | Creates an account for a specified host. |
| GetHostAccount | Queries the details of a specified host account. |
| ListHostAccounts | Queries the host accounts. |
| ModifyHostAccount | Modifies the information about a specified host account, such as the name, password, and private key. |
| DeleteHostAccount | Deletes a specified host account. |
| ResetHostAccountCredential | Deletes the logon credential of a specified host account. The logon credential can be the password or Secure Shell (SSH) private key. |
Users (available only for bastion hosts that run V3.2.17)
| Operation | Description |
|---|---|
| CreateUser | Creates a user for a specified bastion host. |
| GetUser | Queries the details of a user of a specified bastion host. |
| ListUsers | Queries the users of a specified bastion host |
| ModifyUser | Modifies the information about a specified user of a specified bastion host. |
| DeleteUser | Deletes a specified user from a specified bastion host. |
| LockUsers | Locks one or more users of a specified bastion host. |
| UnlockUsers | Unlocks one or more users of a specified bastion host. |
User groups (available only for bastion hosts that run V3.2.17)
| Operation | Description |
|---|---|
| CreateUserGroup | Creates a user group in a specified bastion host. |
| GetUserGroup | Queries the details of a specified user group in a specified bastion host. |
| ListUserGroups | Queries the user groups in a specified bastion host. |
| ModifyUserGroup | Modifies the information about a specified user group. |
| DeleteUserGroup | Deletes a specified user group from a specified bastion host. |
| AddUsersToGroup | Adds one or more users to a specified user group. |
| RemoveUsersFromGroup | Removes one or more users from a specified user group. |
Host authorization (available only for bastion hosts that run V3.2.17)
| Operation | Description |
|---|---|
| AttachHostAccountsToUser | Authorizes a specified user to manage one or more hosts and host accounts. |
| ListHostsForUser | Queries the hosts that a specified user is authorized or not authorized to manage. |
| ListHostAccountsForUser | Queries the host accounts that a specified user is authorized to manage on a specified host. |
| DetachHostAccountsFromUser | Revokes the permissions on one or more hosts and host accounts from a specified user. |
| AttachHostAccountsToUserGroup | Authorizes a specified user group to manage one or more hosts and host accounts. |
| ListHostsForUserGroup | Queries the hosts that a specified user group is authorized or not authorized to manage. |
| ListHostAccountsForUserGroup | Queries the host accounts that a specified user group is authorized to manage on a specified host. |
| DetachHostAccountsFromUserGroup | Revokes the permissions on one or more hosts and host accounts from a specified user group. |
| AttachHostGroupAccountsToUser | Authorizes a specified user to manage one or more host groups and host accounts. |
| ListHostGroupsForUser | Queries the host groups that a specified user is authorized or not authorized to manage. |
| ListHostGroupAccountNamesForUser | Queries the names of the host accounts that a specified user is authorized to manage in a specified host group. |
| DetachHostGroupAccountsFromUser | Revokes permissions on one or more host groups and host accounts from a specified user. |
| AttachHostGroupAccountsToUserGroup | Authorizes a specified user group to manage one or more host groups and host accounts. |
| ListHostGroupsForUserGroup | Queries the host groups that a specified user group is authorized or not authorized to manage. |
| ListHostGroupAccountNamesForUserGroup | Queries the names of the host accounts that a specified user group is authorized to manage in a single host group. |
| DetachHostGroupAccountsFromUserGroup | Revokes permissions on one or more host groups and host accounts from a specified user group. |