All Products
Search
Document Center

Bastionhost:ListOperationHosts

Last Updated:Oct 25, 2024

Queries a list of hosts that the current Resource Access Management (RAM) user is authorized to manage.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-bastionhost:ListOperationHosts
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the bastion host.

Note You can call the DescribeInstances operation to query the ID of the bastion host.
bastionhost-cn-09k22avmw0q
RegionIdstringNo

The region ID of the bastion host.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
cn-hangzhou
PageNumberstringNo

The page number. Default value: 1.

1
PageSizestringNo

The number of entries per page.
Maximum value: 100. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave this parameter empty.
20
OSTypestringNo

The operating system of the host that you want to query. Valid values:

  • Linux
  • Windows
Linux
HostNamestringNo

The name of the host that you want to query. Only exact match is supported.

abc
HostAddressstringNo

The address of the host that you want to query. You can set this parameter to a domain name or an IP address. Only exact match is supported.

10.162.172.132
SourcestringNo

The source of the host that you want to query. Valid values:

  • Local
  • Ecs
Local
SourceInstanceIdstringNo

The ID of the Elastic Compute Service (ECS) instance. Exact match is supported.

i-bp19ienyt0yax748****
SourceInstanceStatestringNo

The status of the host that you want to query. Valid values:

  • Normal
  • Release
Normal

Response parameters

ParameterTypeDescriptionExample
object
Hostsarray<object>

The hosts returned.

itemobject
ActiveAddressTypestring

The address type of the host. Valid values:

  • Public
  • Private
Public
Commentstring

The remarks of the host.

comment
HostIdstring

The host ID.

1
HostNamestring

The host name.

host1
HostPrivateAddressstring

The private IP address of the host.

192.168.XX.XX
HostPublicAddressstring

The public IP address of the host.

10.158.XX.XX
OSTypestring

The host OS.

  • Linux
  • Windows
Linux
Sourcestring

The host type. Valid values:

  • Local: on-premises host.
  • Ecs: Elastic Compute Service (ECS) instance.
Local
SourceInstanceIdstring

The ECS instance ID.

i-bp19ienyt0yax748****
SourceInstanceStatestring

The host status. Valid values:

  • Normal
  • Release
Normal
RequestIdstring

The request ID.

4F6C075F-FC86-476E-943B-097BD4E12948
TotalCountlong

The total number of hosts returned.

5

Examples

Sample success responses

JSONformat

{
  "Hosts": [
    {
      "ActiveAddressType": "Public",
      "Comment": "comment",
      "HostId": "1",
      "HostName": "host1",
      "HostPrivateAddress": "192.168.XX.XX",
      "HostPublicAddress": "10.158.XX.XX",
      "OSType": "Linux",
      "Source": "Local",
      "SourceInstanceId": "i-bp19ienyt0yax748****",
      "SourceInstanceState": "Normal"
    }
  ],
  "RequestId": "4F6C075F-FC86-476E-943B-097BD4E12948",
  "TotalCount": 5
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterThe argument is invalid.The argument is invalid.
500InternalErrorAn unknown error occurred.An unknown error occurred.

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