GetHost - Bastionhost - Alibaba Cloud Documentation Center

Queries the details of a host, such as the name, source, address, protocol, and service port of the host.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-bastionhost:GetHost	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the bastion host in which you want to query the host. Note You can call the DescribeInstances operation to query the ID of the bastion host.	bastionhost-cn-st220aw****
RegionId	string	No	The region ID of the bastion host in which you want to query the host. Note For more information about the mapping between region IDs and region names, see Regions and zones.	cn-hangzhou
HostId	string	Yes	The ID of the host that you want to query. You can specify only one host ID. Note You can call the ListHosts operation to query the ID of the host.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
Host	object	The returned information about the host.
Comment	string	The description of the host.	host
ActiveAddressType	string	The address type of the host. Valid values: Public: a public address Private: a private address	Public
HostPublicAddress	string	The public address of the host. The value is a domain name or an IP address.	1.1.XX.XX
HostName	string	The hostname.	host
Source	string	The source of the host. Valid values: Local: a host in a data center Ecs: an Elastic Compute Service (ECS) instance Rds: a host in an ApsaraDB MyBase dedicated cluster	Local
HostPrivateAddress	string	The internal endpoint of the host. The value is a domain name or an IP address.	192.168.XX.XX
OSType	string	The operating system of the host. Valid values: Linux Windows	Linux
HostId	string	The ID of the host.	1
SourceInstanceState	string	The status of the host. Valid values: Normal: normal Release: released	Normal
SourceInstanceId	string	The ID of the ECS instance or the host in an ApsaraDB MyBase dedicated cluster. Note If Local is returned for the Source parameter, no value is returned for this parameter.	i-bp19ienyt0yax748****
Protocols	array<object>	The protocol information about the host.
Item	object
HostFingerPrint	string	The fingerprint of the host. This parameter uniquely identifies a host. A value is returned for this parameter only if you have performed O&M operations on the host by using the bastion host. Otherwise, no value is returned.	ssh-ed25519\|3e:46:5a:e1:1f:0d:39:7e:61:35:d5:fa:7b:2b::
Port	integer	The service port of the host.	22
ProtocolName	string	The protocol that is used to connect to the host. Valid values: SSH RDP	SSH
NetworkDomainId	string	The ID of the network domain to which the host belongs.	1

Examples

Sample success responses

JSONformat

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "Host": {
    "Comment": "host",
    "ActiveAddressType": "Public",
    "HostPublicAddress": "1.1.XX.XX",
    "HostName": "host",
    "Source": "Local",
    "HostPrivateAddress": "192.168.XX.XX",
    "OSType": "Linux",
    "HostId": "1",
    "SourceInstanceState": "Normal",
    "SourceInstanceId": "i-bp19ienyt0yax748****",
    "Protocols": [
      {
        "HostFingerPrint": "ssh-ed25519|3e:46:5a:e1:1f:0d:39:7e:61:35:d5:fa:7b:2b:**:**",
        "Port": 22,
        "ProtocolName": "SSH"
      }
    ],
    "NetworkDomainId": "1"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The argument is invalid.	The argument is invalid.
400	HostNotFound	The host is not found.	The host is not found.
500	InternalError	An unknown error occurred.	An unknown error occurred.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-11-27	The Error code has changed. The response structure of the API has changed	View Change Details