All Products
Search
Document Center

Bastionhost:List of operations by function

Last Updated:Jan 29, 2023
This product(Yundun-bastionhost/2019-12-09) OpenAPI adopts RPC Signature style, see signature details Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our service nail group (11370001915) and sign under the guidance of experts.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.

Bastion Hosts (available only for bastion hosts that run V3.2.X)

APITitleDescription
DescribeInstanceAttributeDescribeInstanceAttributeQueries the attribute information about the specified bastion host. The information includes the ID and remarks of the bastion host.
DescribeInstancesDescribeInstancesQueries bastion hosts.
ConfigInstanceSecurityGroupsConfigInstanceSecurityGroupsConfigures security groups for a bastion host.
ConfigInstanceWhiteListConfigInstanceWhiteListConfigures a whitelist of public IP addresses for a bastion host.
StartInstanceStartInstanceEnables a bastion host.
EnableInstancePublicAccessEnableInstancePublicAccessEnables Internet access for a bastion host.
DisableInstancePublicAccessDisableInstancePublicAccessDisables Internet access of a bastion host.
ModifyInstanceAttributeModifyInstanceAttributeModifies the name of a specified bastion host.
MoveResourceGroupMoveResourceGroupMoves a bastion host from one resource group to another resource group.

Tags (available only for bastion hosts that run V3.2.X)

APITitleDescription
ListTagKeysListTagKeysQueries the keys of the tags bound to Bastionhost instances.
ListTagResourcesListTagResourcesQueries the tags bound to one or more Bastionhost instances.
UntagResourcesUntagResourcesRemoves tags from a specified bastion host and deletes the tags at a time.
TagResourcesTagResourcesCreates and binds tags to specified Bastionhost instances.

Regions (available only for bastion hosts that run V3.2.X)

APITitleDescription
DescribeRegionsDescribeRegionsQueries available regions where you can create bastion hosts.

Hosts (available only for bastion hosts that run V3.2.17 and later versions)

APITitleDescription
CreateHostCreateHostCreates a host for operations and maintenance (O\&M) in a specified Bastionhost instance.
GetHostGetHostQueries the details of a specified host, such as the name, source, endpoint, protocol, and service port of the host.
ListHostsListHostsQueries the hosts in a specified Bastionhost instance.
DeleteHostDeleteHostDeletes a specified host.
ModifyHostsPortModifyHostsPortChanges the port for the O\\\\\\&M protocol on one or more hosts.
ModifyHostsActiveAddressTypeModifyHostsActiveAddressTypeChanges the portal type of one or more hosts for O\&M.
ModifyHostModifyHostModifies the basic information of a specified host, such as the endpoint, name, operating system, and description of the host.

Host Groups (available only for bastion hosts that run V3.2.17 and later versions)

APITitleDescription
CreateHostGroupCreateHostGroupCreates a host group.
GetHostGroupGetHostGroupQueries the details of a specified host group.
ModifyHostGroupModifyHostGroupModifies the name or description of a specified host group.
DeleteHostGroupDeleteHostGroupDeletes a host group.
AddHostsToGroupAddHostsToGroupAdds one or more hosts to a host group.
RemoveHostsFromGroupRemoveHostsFromGroupRemoves one or more hosts from a host group.

Host Accounts (available only for bastion hosts that run V3.2.17 and later versions)

APITitleDescription
CreateHostAccountCreateHostAccountAdds a host account to a specified host.
GetHostAccountGetHostAccountQueries the details of a specified host account.
ListHostAccountsListHostAccountsQueries accounts of a specified host.
ModifyHostAccountModifyHostAccountModifies the information about a specified host account, such as the name, password, and private key.
DeleteHostAccountDeleteHostAccountRemoves a host account.
ResetHostAccountCredentialResetHostAccountCredentialDeletes the logon credential of a specified host account of a specified Bastionhost instance. The logon credential can be the password or SSH private key.

Users (available only for bastion hosts that run V3.2.17 and later versions)

APITitleDescription
CreateUserCreateUserAdds a user to a bastion host.
GetUserGetUserQueries the information of a specified user of a specified Bastionhost instance.
ListUsersListUsersQueries the users of a specified Bastionhost instance.
DeleteUserDeleteUserDeletes a specified user of a specified Bastionhost instance.
LockUsersLockUsersLocks one or more users of a bastion host.
UnlockUsersUnlockUsersUnlocks one or more users of a bastion host.

User Groups (available only for bastion hosts that run V3.2.17 and later versions)

APITitleDescription
CreateUserGroupCreateUserGroupCreates a user group for a specified bastion host.
GetUserGroupGetUserGroupQueries the details of a specified user group in a specified Bastionhost instance.
ListUserGroupsListUserGroupsQueries the user groups in a specified Bastionhost instance.
ModifyUserGroupModifyUserGroupModifies the name or description of a specified user group in a specified Bastionhost instance.
DeleteUserGroupDeleteUserGroupDeletes a specified user group from a specified Bastionhost instance.
AddUsersToGroupAddUsersToGroupAdds one or more users to a user group.
RemoveUsersFromGroupRemoveUsersFromGroupRemoves one or more users from a user group.

Host Authorization (available only for bastion hosts that run V3.2.17 and later versions)

APITitleDescription
AttachHostAccountsToUserAttachHostAccountsToUserAuthorizes a user to manage one or more hosts and host accounts.
ListHostsForUserListHostsForUserQueries the hosts that a specified user is authorized or not authorized to manage.
ListHostAccountsForUserListHostAccountsForUserQueries the host accounts that a specified user is authorized to manage on a specified host.
DetachHostAccountsFromUserDetachHostAccountsFromUserRevokes the permissions on one or more hosts and host accounts from a user.
DetachHostAccountsFromUserGroupDetachHostAccountsFromUserGroupRevokes the permissions on one or more hosts and host accounts from a user group.
DetachHostGroupAccountsFromUserDetachHostGroupAccountsFromUserRevokes permissions on one or more host groups and host accounts from a user.
AttachHostAccountsToUserGroupAttachHostAccountsToUserGroupAuthorizes a user group to manage one or more hosts and host accounts.
DetachHostGroupAccountsFromUserGroupDetachHostGroupAccountsFromUserGroupRevokes permissions on one or more host groups and host accounts from a user group.
AttachHostGroupAccountsToUserAttachHostGroupAccountsToUserAuthorizes a user to manage one or more host groups and host accounts.
AttachHostGroupAccountsToUserGroupAttachHostGroupAccountsToUserGroupAuthorizes a user group to manage one or more host groups and host accounts.
ListHostAccountsForUserGroupListHostAccountsForUserGroupQueries the host accounts that a specified user group is authorized to manage on a specified host.
ListHostGroupAccountNamesForUserListHostGroupAccountNamesForUserQueries the names of the host accounts that a specified user is authorized to manage in a specified host group.
ListHostGroupAccountNamesForUserGroupListHostGroupAccountNamesForUserGroupQueries the names of the host accounts that a specified user group is authorized to manage in a specified host group.
ListHostGroupsForUserListHostGroupsForUserQueries the host groups that a specified user is authorized or not authorized to manage.
ListHostGroupsForUserGroupListHostGroupsForUserGroupQueries the host groups that a specified user group is authorized or not authorized to manage.
ListHostsForUserGroupListHostsForUserGroupQueries the hosts that a specified user group is authorized or not authorized to manage.

Asset Management (available only for bastion hosts that run V3.2.X)

APITitleDescription
CreateHostShareKeyCreateHostShareKeyCreates a shared key.
GetHostShareKeyGetHostShareKeyQueries the details of a shared key.
ListHostShareKeysListHostShareKeysQueries the shared keys that are associated with a host.
ListHostAccountsForHostShareKeyListHostAccountsForHostShareKeyQueries the host accounts that are associated with a shared key.
ModifyHostShareKeyModifyHostShareKeyModifies the information about a shared key.
AttachHostAccountsToHostShareKeyAttachHostAccountsToHostShareKeyAssociates host accounts with a shared key.
DetachHostAccountsFromHostShareKeyDetachHostAccountsFromHostShareKeyDisassociates host accounts from a shared key.
DeleteHostShareKeyDeleteHostShareKeyDeletes a shared key.

System Settings (available only for bastion hosts that run V3.2.X)

APITitleDescription
GetInstanceADAuthServerGetInstanceADAuthServerQueries the settings of Active Directory (AD) authentication on a bastion host.
ModifyInstanceADAuthServerModifyInstanceADAuthServerModifies the settings of Active Directory (AD) authentication on a bastion host.
GetInstanceTwoFactorGetInstanceTwoFactorQueries the settings of two-factor authentication on a bastion host.
ModifyInstanceTwoFactorModifyInstanceTwoFactorModifies the settings of two-factor authentication on a bastion host.
ModifyInstanceLDAPAuthServerModifyInstanceLDAPAuthServerModifies the settings of Lightweight Directory Access Protocol (LDAP) authentication on a bastion host.
GetInstanceLDAPAuthServerGetInstanceLDAPAuthServerQueries the settings of Lightweight Directory Access Protocol (LDAP) authentication on a bastion host.