This product(
Yundun-bastionhost/2019-12-09) OpenAPI adopts RPC Signature style. See signature details in 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 DingTalk service 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)
| API | Title | Description |
|---|---|---|
| DescribeInstanceAttribute | DescribeInstanceAttribute | Queries the attribute information about the specified bastion host. The information includes the ID and remarks of the bastion host. |
| DescribeInstances | DescribeInstances | Queries bastion hosts. |
| ConfigInstanceSecurityGroups | ConfigInstanceSecurityGroups | Configures security groups for a bastion host. |
| ConfigInstanceWhiteList | ConfigInstanceWhiteList | Configures a whitelist of public IP addresses for a bastion host. |
| StartInstance | StartInstance | Enables the specified bastion host. |
| EnableInstancePublicAccess | EnableInstancePublicAccess | Enables Internet access for a bastion host. |
| DisableInstancePublicAccess | DisableInstancePublicAccess | Disables Internet access for a bastion host. |
| ModifyInstanceAttribute | ModifyInstanceAttribute | Modifies the information about the specified bastion host. |
| MoveResourceGroup | MoveResourceGroup | Moves a bastion host from one resource group to another resource group. |
Tags (available only for bastion hosts that run V3.2.X)
| API | Title | Description |
|---|---|---|
| ListTagKeys | ListTagKeys | Queries the tags that are added to a resource. |
| ListTagResources | ListTagResources | Queries the tags bound to one or more Bastionhost instances. |
| UntagResources | UntagResources | Removes tags from the specified bastion host and deletes the tags at a time. |
| TagResources | TagResources | Creates and adds tags to specified bastion hosts. |
Regions (available only for bastion hosts that run V3.2.X)
| API | Title | Description |
|---|---|---|
| DescribeRegions | DescribeRegions | Queries available regions where you can create bastion hosts. |
Hosts (available only for bastion hosts that run V3.2.17 and later versions)
| API | Title | Description |
|---|---|---|
| CreateHost | CreateHost | Creates a host for O\\\&M in the specified bastion host. |
| GetHost | GetHost | Queries the details of a host, such as the name, source, address, protocol, and service port of the host. |
| ListHosts | ListHosts | Queries the hosts in a bastion host. |
| DeleteHost | DeleteHost | Deletes the specified host. |
| ModifyHostsPort | ModifyHostsPort | Changes the port for the O\\\\\\&M protocol on one or more hosts. |
| ModifyHostsActiveAddressType | ModifyHostsActiveAddressType | Changes the portal type of one or more hosts for O\&M. |
| ModifyHost | ModifyHost | Modifies information about a host. The information includes the address, name, and description of the host and the operating system that the host runs. |
Host Accounts (available only for bastion hosts that run V3.2.17 and later versions)
| API | Title | Description |
|---|---|---|
| CreateHostAccount | CreateHostAccount | Creates a host account for a host. |
| GetHostAccount | GetHostAccount | Queries the details of a specified host account. |
| ListHostAccounts | ListHostAccounts | Queries accounts of a specified host. |
| ModifyHostAccount | ModifyHostAccount | Modifies the information about a specified host account, such as the name, password, and private key. |
| DeleteHostAccount | DeleteHostAccount | Removes a host account. |
Users (available only for bastion hosts that run V3.2.17 and later versions)
| API | Title | Description |
|---|---|---|
| CreateUser | CreateUser | Adds a user to a bastion host. |
| GetUser | GetUser | Queries the details of a user of the specified bastion host. |
| ListUsers | ListUsers | Queries the users of a specified Bastionhost instance. |
| ModifyUser | ModifyUser | Modifies the information about a user of a bastion host. |
| DeleteUser | DeleteUser | Deletes a specified user from a specified bastion host. |
| CreateUserPublicKey | CreateUserPublicKey | Creates a public key for the specified user. |
| ListUserPublicKeys | ListUserPublicKeys | Queries all public keys of the specified user. |
| ModifyUserPublicKey | ModifyUserPublicKey | Modifies the public key of the user. |
| DeleteUserPublicKey | DeleteUserPublicKey | Deletes a public key from the specified user. |
| LockUsers | LockUsers | Locks one or more users of a bastion host. |
| UnlockUsers | UnlockUsers | Unlocks one or more users of a bastion host. |
User Groups (available only for bastion hosts that run V3.2.17 and later versions)
| API | Title | Description |
|---|---|---|
| CreateUserGroup | CreateUserGroup | Creates a user group for the specified bastion host. |
| GetUserGroup | GetUserGroup | Queries the details of a user group in a bastion host. |
| ListUserGroups | ListUserGroups | Queries the user groups on the specified bastion host. |
| ModifyUserGroup | ModifyUserGroup | Modifies the information about the specified user group. |
| DeleteUserGroup | DeleteUserGroup | Deletes a specified user group from a specified bastion host. |
| AddUsersToGroup | AddUsersToGroup | Add one or more users to a user group. |
| RemoveUsersFromGroup | RemoveUsersFromGroup | Removes one or more users from a user group. |
Host Groups (available only for bastion hosts that run V3.2.17 and later versions)
| API | Title | Description |
|---|---|---|
| CreateHostGroup | CreateHostGroup | Creates a host group. |
| AddHostsToGroup | AddHostsToGroup | Adds one or more hosts to the specified host group. |
| DeleteHostGroup | DeleteHostGroup | Deletes a host group. |
| RemoveHostsFromGroup | RemoveHostsFromGroup | Removes one or more hosts from a host group. |
| ModifyHostGroup | ModifyHostGroup | Modifies the name or description of the specified host group. |
| GetHostGroup | GetHostGroup | Queries the details of a specified host group. |
| ListHostGroups | ListHostGroups | Queries host groups in a specified bastion host. |
Host Authorization (available only for bastion hosts that run V3.2.17 and later versions)
| API | Title | Description |
|---|---|---|
| AttachHostAccountsToUser | AttachHostAccountsToUser | Authorizes a user to manage the hosts and host accounts. |
| ListHostsForUser | ListHostsForUser | Queries the hosts that a user group is authorized or not authorized to manage. |
| ListHostAccountsForUser | ListHostAccountsForUser | Queries the host accounts that the specified user is authorized to manage on the specified host. |
| DetachHostAccountsFromUser | DetachHostAccountsFromUser | Revokes the permissions on one or more hosts and host accounts from a user. |
| DetachHostAccountsFromUserGroup | DetachHostAccountsFromUserGroup | Revokes the permissions on one or more hosts and host accounts from a user group. |
| DetachHostGroupAccountsFromUser | DetachHostGroupAccountsFromUser | Revokes permissions on one or more host groups and host accounts from a user. |
| AttachHostAccountsToUserGroup | AttachHostAccountsToUserGroup | Authorizes a user group to manage one or more hosts and host accounts. |
| DetachHostGroupAccountsFromUserGroup | DetachHostGroupAccountsFromUserGroup | Revokes permissions on one or more host groups and host accounts from a user group. |
| AttachHostGroupAccountsToUser | AttachHostGroupAccountsToUser | Authorizes a user to manage one or more host groups and host accounts. |
| AttachHostGroupAccountsToUserGroup | AttachHostGroupAccountsToUserGroup | Authorizes a user to manage one or more host groups and host accounts. |
| ListHostAccountsForUserGroup | ListHostAccountsForUserGroup | Queries the host accounts of the specified host that the specified user group is authorized to manage. |
| ListHostGroupAccountNamesForUser | ListHostGroupAccountNamesForUser | Queries the names of the host accounts that a specified user is authorized to manage in a specified host group. |
| ListHostGroupAccountNamesForUserGroup | ListHostGroupAccountNamesForUserGroup | Queries the names of the host accounts that a user group is authorized to manage in a host group. |
| ListHostGroupsForUser | ListHostGroupsForUser | Queries the host groups that a specified user is authorized or not authorized to manage. |
| ListHostGroupsForUserGroup | ListHostGroupsForUserGroup | Queries the hosts that a specified user group is authorized or not authorized to manage. |
| ListHostsForUserGroup | ListHostsForUserGroup | Queries the hosts that a user group is authorized or not authorized to manage. |
| API | Title | Description |
|---|---|---|
| AcceptOperationTicket | AcceptOperationTicket | Approves an O\\\\\\&M application. |
| RejectOperationTicket | RejectOperationTicket | Rejects an O\&M application. |
Asset Management (available only for bastion hosts that run V3.2.X)
| API | Title | Description |
|---|---|---|
| CreateHostShareKey | CreateHostShareKey | Creates a shared key. |
| GetHostShareKey | GetHostShareKey | Queries the details of a shared key. |
| ListHostShareKeys | ListHostShareKeys | Queries the shared keys that are associated with a host. |
| ListHostAccountsForHostShareKey | ListHostAccountsForHostShareKey | Queries the host accounts that are associated with a shared key. |
| ModifyHostShareKey | ModifyHostShareKey | Modifies the information about a shared key. |
| AttachHostAccountsToHostShareKey | AttachHostAccountsToHostShareKey | Associates host accounts with a shared key. |
| DetachHostAccountsFromHostShareKey | DetachHostAccountsFromHostShareKey | Disassociates host accounts from a shared key. |
| DeleteHostShareKey | DeleteHostShareKey | Deletes a shared key. |
System Settings (available only for bastion hosts that run V3.2.X)
| API | Title | Description |
|---|---|---|
| GetInstanceADAuthServer | GetInstanceADAuthServer | Queries the settings of Active Directory (AD) authentication on a bastion host. |
| ModifyInstanceADAuthServer | ModifyInstanceADAuthServer | Modifies the settings of Active Directory (AD) authentication on a bastion host. |
| GetInstanceTwoFactor | GetInstanceTwoFactor | Queries the settings of two-factor authentication on a bastion host. |
| ModifyInstanceTwoFactor | ModifyInstanceTwoFactor | Modifies the settings of two-factor authentication on a bastion host. |
| ModifyInstanceLDAPAuthServer | ModifyInstanceLDAPAuthServer | Modifies the settings of Lightweight Directory Access Protocol (LDAP) authentication on a bastion host. |
| GetInstanceLDAPAuthServer | GetInstanceLDAPAuthServer | Queries the settings of Lightweight Directory Access Protocol (LDAP) authentication on a bastion host. |