All Products
Search

This Product

    Bastionhost:ListOperationHostAccounts

    Document Center

    Bastionhost:ListOperationHostAccounts

    Last Updated:Oct 25, 2024

    Queries a list of host accounts 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:ListOperationHostAccounts
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The bastion host ID.

    Note You can call the DescribeInstances operation to query the bastion host ID.
    		bastionhost-cn-st220aw****
    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
    HostIdstringYes

    The ID of the host whose accounts you want to query.

    Note You can call the ListOperationHosts operation to query the host ID.
    		1
    PageNumberstringNo

    The page number. Default value: 1.

    		1
    PageSizestringNo

    The number of entries per page.
    Valid values: 1 to 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
    HostAccountNamestringNo

    The name of the host account to query. Only exact match is supported.

    		root

    Response parameters

    ParameterTypeDescriptionExample
    object
    HostAccountsarray<object>

    The host accounts returned.

    itemobject
    HasPasswordboolean

    Indicates whether a password is configured for the host account.

    • true
    • false
    		true
    HostAccountIdstring

    The host account ID.

    		1
    HostAccountNamestring

    The host account name.

    		root
    HostIdstring

    The host ID.

    		１
    HostShareKeyIdstring

    The ID of the shared key that is associated with the host.

    		3
    PrivateKeyFingerprintstring

    The fingerprint of the private key for the host account.

    		fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**
    ProtocolNamestring

    The protocol that is used by the host account.

    • SSH
    • RDP
    		SSH
    SSHConfigobject

    Indicates whether the Secure File Transfer Protocol (SFTP) channels or the SSH channels are enabled for the host account that uses the SSH protocol.

    EnableSFTPChannelboolean

    Indicates whether SFTP channels are enabled for the account.

    EnableSSHChannelboolean

    Indicates whether SSH channels are enabled for the account.

    RequestIdstring

    The request ID.

    		EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
    TotalCountlong

    The total number of host accounts returned.

    		1

    Examples

    Sample success responses

    JSONformat

    {
  "HostAccounts": [
    {
      "HasPassword": true,
      "HostAccountId": "1",
      "HostAccountName": "root",
      "HostId": "１",
      "HostShareKeyId": "3",
      "PrivateKeyFingerprint": "fe:ca:37:42:30:00:9d:95:e6:73:e5:b0:32:0a:**:**",
      "ProtocolName": "SSH",
      "SSHConfig": {
        "EnableSFTPChannel": true,
        "EnableSSHChannel": true
      }
    }
  ],
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "TotalCount": 1
}

    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.