查询资产组成员列表

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

1. 接口描述

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

查询资产组成员列表

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeDeviceGroupMembers
Version String 公共参数,本接口取值:2019-10-18
Region String 公共参数,地域信息本接口不需要传递此参数。
Id Uint64 资产组ID
示例值: 1
IdSet Array of Uint64 资产组ID集合,传Id,IdSet不生效。
示例值: [1,2,3]
Name String 资产名或资产IP,模糊查询
示例值: 运维主机
Bound Bool true - 查询已在该资产组的资产,false - 查询未在该资产组的资产
示例值: true
Offset Uint64 分页偏移位置,默认值为0
示例值: 0
Limit Uint64 每页条目数,默认20, 最大500
示例值: 10
Kind Uint64 资产类型,1 - Linux,2 - Windows,3 - MySQL,4 - SQLServer
示例值: 1
DepartmentId String 所属部门ID
示例值: 1.2.3
KindSet Array of Uint64 资产类型集合,1 - Linux,2 - Windows,3 - MySQL,4 - SQLServer
示例值: [1,2,3]
TagFilters Array of TagFilter 过滤条件,可按照标签键、标签进行过滤。如果同时指定标签键和标签过滤条件,它们之间为“AND”的关系
示例值:查看

3. 输出参数

参数名称 类型 描述
TotalCount Uint64 资产组成员总数
示例值: 10
DeviceSet Array of Device 资产组成员列表
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
UnsupportedOperation 操作不支持。
InvalidParameter 参数错误。
InternalError 内部错误。
ResourceNotFound 资源不存在。
InvalidParameterValue 参数取值错误。
FailedOperation 操作失败。
FailedOperation.DataNotFound 目标数据不存在。

5. 示例

示例1 查询资产组成员列表

输入示例

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

{
    "Id": 1, 
    "Name": "研发主机", 
    "Bound": true
}

输出示例

{
    "Response": {
        "TotalCount": 1, 
        "RequestId": "xx", 
        "DeviceSet": [
            {
                "Kind": 1, 
                "GroupSet": [
                    {
                        "Department": {
                            "Managers": [
                                "xx"
                            ], 
                            "Id": "xx", 
                            "Name": "xx"
                        }, 
                        "Id": 1, 
                        "Name": "xx"
                    }
                ], 
                "Resource": {
                    "RenewFlag": 1, 
                    "Zone": "xx", 
                    "SubnetName": "xx", 
                    "Nodes": 1, 
                    "Status": 1, 
                    "VpcId": "xx", 
                    "SubProductCode": "xx", 
                    "ResourceId": "xx", 
                    "PackageBandwidth": 1, 
                    "VpcName": "xx", 
                    "ApCode": "xx", 
                    "SubnetId": "xx", 
                    "ResourceName": "xx", 
                    "Expired": true, 
                    "Deployed": true, 
                    "ProductCode": "xx", 
                    "PublicIpSet": [
                        "xx"
                    ], 
                    "ModuleSet": [
                        "xx"
                    ], 
                    "ExtendPoints": 1, 
                    "UsedNodes": 1, 
                    "PrivateIpSet": [
                        "xx"
                    ], 
                    "Pid": 1, 
                    "VpcCidrBlock": "xx", 
                    "PackageNode": 1, 
                    "ExpireTime": "2020-09-22T00:00:00+00:00", 
                    "SvArgs": "xx", 
                    "CidrBlock": "xx", 
                    "CreateTime": "2020-09-22T00:00:00+00:00"
                }, 
                "Name": "xx", 
                "InstanceId": "xx", 
                "OsName": "xx", 
                "AccountCount": 1, 
                "PrivateIp": "xx", 
                "PublicIp": "xx", 
                "Department": {
                    "Managers": [
                        "xx"
                    ], 
                    "Id": "xx", 
                    "Name": "xx"
                }, 
                "VpcId": "xx", 
                "ApCode": "xx", 
                "SubnetId": "xx", 
                "Port": 1, 
                "Id": 1
            }
        ]
    }
}