All Products
Search

This Product

    Bastionhost:ListHostsForUser

    Document Center

    Bastionhost:ListHostsForUser

    Last Updated:Jan 12, 2023

    Queries the hosts that a specified user is authorized or not authorized to manage.

    Authorization information

    The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

    • 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 keyword: refers to the condition keyword defined by the cloud product itself.
    • 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.
    Operate access level Resource type conditional keyword Association operation
    yundun-bastionhost:ListHostsForUser Read
      All resources
      without
    		without

    Request parameters

    Parameter Type Required Description Example
    InstanceId string Yes

    The ID of the Bastionhost instance where you want to query the hosts that the user is authorized or not authorized to manage.

    Note You can call the DescribeInstances operation to query the ID of the Bastionhost instance.
    		bastionhost-cn-st220aw****
    RegionId string No

    The region ID of the Bastionhost instance where you want to query the hosts that the user is authorized or not authorized to manage.

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

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

    • Authorized: Query the hosts that the user is authorized to manage. This is the default value.
    • Unauthorized: Query the hosts that the user is not authorized to manage.
    		 Authorized
    UserId string Yes

    The ID of the user.

    Note You can call the ListUsers operation to query the ID of the user ID.
    		1
    PageNumber string No

    The number of the page to return. Default value: 1.

    		 1
    PageSize string No

    The number of entries to return on each page.

    The value of the PageSize parameter must not exceed 100. Default value: 20. If you leave the PageSize parameter empty, 20 entries are returned on each page.

    Note We recommend that you do not leave the PageSize parameter empty.
    		20
    HostAddress string No

    The endpoint 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.

    		 192.168.XX.XX
    HostName string No

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

    		 abc
    OSType string No

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

    • Linux
    • Windows
    		 Linux

    All Bastionhost API requests must include common request parameters. For more information about common request parameters, see Common parameters.

    For more information about sample requests, see the "Examples" section of this topic.

    Response parameters

    Parameter Type Description Example
    object
    TotalCount integer

    The total number of hosts returned.

    		 1
    RequestId string

    The ID of the request.

    		 EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
    Hosts array

    The hosts returned.
    object
    Comment string

    The description of the host.

    		 comment
    ActiveAddressType string

    The endpoint type of the host. Valid values:

    • Public: a public endpoint
    • Private: an internal endpoint
    		 Public
    HostPublicAddress string

    The public endpoint of the host. The value is a domain name or an IP address.

    		 10.158.XX.XX
    HostName string

    The name of the host.

    		 host01
    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

    Example

    Normal return example

    JSONFormat

    {
  "TotalCount": 1,
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE ",
  "Hosts": [
    {
      "Comment": "comment",
      "ActiveAddressType": "Public",
      "HostPublicAddress": "10.158.XX.XX",
      "HostName": "host01",
      "HostPrivateAddress": "192.168.XX.XX",
      "OSType": "Linux",
      "HostId": "1"
    }
  ]
}

    Error codes

    Http code Error code Error message
    400 InvalidParameter The argument is invalid.
    500 InternalError An unknown error occurred.

    For a list of error codes, visit the API error center.