全部产品
Search
文档中心

运维安全中心(堡垒机):ListHostAccountsForHostShareKey - 获取主机共享密钥关联的主机账号

更新时间:Nov 27, 2024

获取主机共享密钥关联的主机账号。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-bastionhost:ListHostAccountsForHostShareKeyget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

堡垒机的实例 ID。

说明 您可以调用 DescribeInstances 接口获取该参数。
bastionhost-cn-st220aw****
RegionIdstring

堡垒机的地域 ID。

说明 Region ID 和地域名称的对应关系,请参见地域和可用区
cn-hangzhou
HostShareKeyIdstring

主机共享密钥的 ID。

说明 您可以调用 ListHostShareKeys 接口获取该参数。
1124
PageNumberstring

设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。

1
PageSizestring

设置分页查询时,每页显示的主机共享密钥关联的主机账号的数量。默认值为 10,表示每页显示 10 条主机共享密钥关联的主机账号。

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

EC9BF0F4-8983-491A-BC8C-1B4DD94976DE
HostAccountsarray<object>

主机共享密钥关联的主机账号的列表。

Itemobject
HostAccountNamestring

主机账号的名称。

root1234
HostIdstring

主机的 ID。

1113
HostsAccountIdstring

主机账号的 ID。

1235
ProtocolNamestring

运维协议的名称。

SSH
TotalCountlong

主机共享密钥关联的主机账号的总数量。

5

示例

正常返回示例

JSON格式

{
  "RequestId": "EC9BF0F4-8983-491A-BC8C-1B4DD94976DE",
  "HostAccounts": [
    {
      "HostAccountName": "root1234",
      "HostId": "1113",
      "HostsAccountId": "1235",
      "ProtocolName": "SSH"
    }
  ],
  "TotalCount": 5
}

错误码

HTTP status code错误码错误信息描述
400HostShareKeyNotFoundThe host share key is not found.-
400InvalidParameterThe argument is invalid.参数错误
500InternalErrorAn unknown error occurred.未知错误

访问错误中心查看更多错误码。