查询主机账号列表

最近更新时间: 2026-09-17 00:00:20

1. 接口描述

接口请求域名： bhsaas.api3.fincloud.tencent.cn。

查询主机账号列表

默认接口请求频率限制：20次/秒。

接口更新时间：2023-09-05 03:34:56。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeDeviceAccounts
Version	是	否	String	公共参数，本接口取值：2019-10-18
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
IdSet	否	否	Array of Uint64	主机账号ID集合，非必需，如果使用IdSet则忽略其他过滤参数示例值： [1,2]
Account	否	否	String	主机账号名，模糊查询，不能单独出现，必须于DeviceId一起提交示例值： root
DeviceId	否	否	Uint64	主机ID，未使用IdSet时必须携带示例值： 1
Offset	否	否	Uint64	分页偏移位置，默认值为0 示例值： 0
Limit	否	否	Uint64	每页条目数量，默认20 示例值： 10

3. 输出参数

参数名称	类型	描述
TotalCount	Uint64	记录总数示例值： 20
DeviceAccountSet	Array of DeviceAccount	账号信息列表示例值：查看
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
InternalError	内部错误。
ResourceNotFound	资源不存在。
InvalidParameterValue	参数取值错误。

5. 示例

示例1 查询主机账号列表

查询主机账号列表

输入示例

POST / HTTP/1.1
Host: dasb.platformcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceAccounts
<公共请求参数>

{
  "DeviceId":1,
  "Account":"sn"
}

输出示例

{
    "Response": {
        "TotalCount": 1, 
        "RequestId": "xx", 
        "DeviceAccountSet": [
            {
                "BoundPrivateKey": true, 
                "Account": "xx", 
                "Id": 1, 
                "BoundPassword": true, 
                "DeviceId": 1
            }
        ]
    }
}