1. 接口描述
接口请求域名： bhsaas.api3.fincloud.tencent.com。
查询资产列表
默认接口请求频率限制：20次/秒。
接口更新时间：2023-09-05 03:34:55。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeDevices |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-10-18 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| IdSet | 否 | 否 | Array of Uint64 | 资产ID集合 示例值： [1,2,3] |
| Name | 否 | 否 | String | 资产名或资产IP，模糊查询 示例值： 运维主机 |
| Ip | 否 | 否 | String | 暂未使用 示例值： 192.168.0.3 |
| ApCodeSet | 否 | 否 | Array of String | 地域码集合 示例值： ["ap-city"] |
| Kind | 否 | 否 | Uint64 | 操作系统类型, 1 - Linux, 2 - Windows, 3 - MySQL, 4 - SQLServer 示例值： 1 |
| Offset | 否 | 否 | Uint64 | 分页偏移位置，默认值为0 示例值： 0 |
| Limit | 否 | 否 | Uint64 | 每页条目数量，默认20 示例值： 10 |
| AuthorizedUserIdSet | 否 | 否 | Array of Uint64 | 有该资产访问权限的用户ID集合 示例值： [1,2] |
| ResourceIdSet | 否 | 否 | Array of String | 过滤条件，资产绑定的堡垒机服务ID集合 示例值： ["bh-saas-test"] |
| KindSet | 否 | 否 | Array of Uint64 | 可提供按照多种类型过滤, 1 - Linux, 2 - Windows, 3 - MySQL, 4 - SQLServer 示例值： [1,2] |
| ManagedAccount | 否 | 否 | String | 资产是否包含托管账号。1，包含；0，不包含 示例值： root |
| DepartmentId | 否 | 否 | String | 过滤条件，可按照部门ID进行过滤 示例值： 1.2.3 |
| TagFilters | 否 | 否 | Array of TagFilter | 过滤条件，可按照标签键、标签进行过滤。如果同时指定标签键和标签过滤条件，它们之间为“AND”的关系 示例值：查看 |
| Filters | 否 | 否 | Array of Filter | 过滤数组。支持的Name： BindingStatus 绑定状态 示例值：查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Uint64 | 资产总数 示例值： 1 |
| DeviceSet | Array of Device | 资产信息列表 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| UnsupportedOperation | 操作不支持。 |
| InvalidParameter | 参数错误。 |
| InternalError | 内部错误。 |
| ResourceNotFound | 资源不存在。 |
| InvalidParameterValue | 参数取值错误。 |