查询堡垒机服务信息

最近更新时间: 2026-10-11 00:08:29

1. 接口描述

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

查询用户购买的堡垒机服务信息，包括资源ID、授权点数、VPC、过期时间等。

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

接口更新时间：2023-09-06 01:35:36。

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeResources
Version	是	否	String	公共参数，本接口取值：2019-10-18
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
ApCode	否	否	String	地域码, 如: ap-city 示例值： ap-city
VpcId	否	否	String	按照堡垒机开通的 VPC 实例ID查询示例值： vpc-9juy78n
ResourceIds	否	否	Array of String	资源ID集合，当传入ID集合时忽略 ApCode 和 VpcId 示例值： ["bh-saas-8jy7jg"]
UseRegion	否	是	String	是否使用公参 Region，1 是，0 否示例值： 1
Limit	否	是	Uint64	每页条目数量示例值： 20
Offset	否	是	Uint64	分页偏移位置示例值： 0

3. 输出参数

参数名称	类型	描述
ResourceSet	Array of Resource	堡垒机资源列表示例值：查看
TotalCount	Uint64	堡垒机资源数量示例值： 0
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码	描述
InvalidParameter	参数错误。
InternalError	内部错误。
InvalidParameterValue	参数取值错误。

5. 示例

示例1 查询资源信息

查询用户购买的资源信息，包括资源ID，授权点数，vpc，过期时间等。

输入示例

POST / HTTP/1.1
Host: dasb.platformcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResources
<Common Parameters>

{}

输出示例

{
    "Response": {
        "RequestId": "xx", 
        "ResourceSet": [
            {
                "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"
            }
        ]
    }
}