1. 接口描述
接口请求域名: bhsaas.api3.fincloud.tencent.cn。
查询堡垒机所有租户的实例
默认接口请求频率限制:20次/秒。
接口更新时间:2025-02-20 10:42:38。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeResourceAll |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-10-18 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| Limit | 是 | 否 | Uint64 | 每页条目数量 示例值: 10 |
| Offset | 是 | 否 | Uint64 | 分页偏移位置 示例值: 0 |
| Filters | 否 | 否 | Array of Filter | 过滤条件 示例值:查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Item | Array of Resource | 堡垒机资源列表 示例值:查看 |
| TotalCount | Uint64 | 堡垒机实例总数 示例值: 1 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
5. 示例
示例1 查询堡垒机所有实例
输入示例
{
"Limit": 10,
"Offset": 0,
"Filters": [],
"Version": "2019-10-18",
"Language": "zh-CN"
}
输出示例
{
"Response": {
"Item": [
{
"Resource": {
"Id": 807,
"ResourceId": "bh-saas-i7zxkanl",
"ResourceName": "堡垒机/专业版",
"AppId": 1255000467,
"Uin": "110000000600",
"Region": "ap-city-hqtest-ops",
"VpcId": "vpc-4tbo9glh",
"SubnetId": "subnet-lzrmhulu",
"CreateTime": "2025-06-05T11:29:33+08:00",
"InitTime": "2025-06-10T14:12:36+08:00",
"ExpireTime": "2125-06-05T11:29:33+08:00",
"ProductCode": "p_cds_dasb",
"SubProductCode": "sp_cds_dasb_bh_saas_pro",
"SvArgs": "sv_cds_dasb_saas_pro_50node",
"Status": 3,
"Remark": "",
"ClbId": "lb-obteelr7",
"OutIp": "9.30.0.12"
},
"ResourceCvm": [
{
"Id": 768,
"CvmId": "ins-qmol0n51",
"AppId": "",
"ResourceId": "bh-saas-i7zxkanl",
"Ip": "9.30.0.13",
"CreateTime": "2025-06-05T11:30:34+08:00",
"InitTime": "1970-01-01T08:00:01+08:00",
"Status": 3,
"Remark": ""
}
]
},
{
"Resource": {
"Id": 806,
"ResourceId": "bh-saas-drngirv3",
"ResourceName": "堡垒机/专业版",
"AppId": 1255000650,
"Uin": "110000000916",
"Region": "ap-city-hqtest-ops",
"VpcId": "",
"SubnetId": "",
"CreateTime": "2025-06-05T11:25:53+08:00",
"InitTime": "1970-01-01T08:00:01+08:00",
"ExpireTime": "2125-06-05T11:25:53+08:00",
"ProductCode": "p_cds_dasb",
"SubProductCode": "sp_cds_dasb_bh_saas_pro",
"SvArgs": "sv_cds_dasb_saas_pro_100node",
"Status": 0,
"Remark": "",
"ClbId": null,
"OutIp": null
},
"ResourceCvm": null
}
],
"RequestId": "ef47370d-6d1b-2136-270d-338e4f4b75e4",
"TotalCount": 2
}
}