1. 接口描述
接口请求域名： bh.tencentcloudapi.com 。
查询用户购买的堡垒机服务信息，包括资源ID、授权点数、VPC、过期时间等。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeResources。 |
| Version | 是 | String | 公共参数，本接口取值：2023-04-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| ApCode | 否 | String | 地域码, 如: ap-guangzhou 示例值：ap-guangzhou |
| VpcId | 否 | String | 按照堡垒机开通的 VPC 实例ID查询 示例值：vpc-9juy78n |
| ResourceIds.N | 否 | Array of String | 资源ID集合，当传入ID集合时忽略 ApCode 和 VpcId 示例值：["bh-saas-8jy7jg"] |
| Limit | 否 | Integer | 每页条目数量 示例值：20 |
| Offset | 否 | Integer | 分页偏移位置 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ResourceSet | Array of Resource | 堡垒机资源列表 |
| TotalCount | Integer | 堡垒机资源数量 示例值：0 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询资源信息
输入示例
POST / HTTP/1.1
Host: bh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResources
<公共请求参数>
{}输出示例
{
"Response": {
"ResourceSet": [
{
"ApCode": "ap-g****zhou",
"BillingRegion": "ap-***ers",
"BillingZone": "ap-o****s-4",
"CdcClusterId": "",
"CidrBlock": "192.1*****.0/24",
"ClbSet": [
{
"ClbIp": "114.1*****.171"
}
],
"ClientAccess": 1,
"CreateTime": "2023-09-07T11:13:47+08:00",
"DeployCvmCount": 2,
"DeployModel": 0,
"Deployed": true,
"DomainCount": 0,
"DomainName": "",
"EnabledDomainCount": 0,
"ExpireTime": "2027-04-28T16:44:13+08:00",
"Expired": false,
"ExtendPoints": 0,
"ExternalAccess": 1,
"IOAResource": 1,
"IOAResourceId": "ioa-bh-0-36***********8e27f4274a",
"IntranetAccess": 0,
"IntranetPrivateIpSet": [],
"IntranetSubnetId": "",
"IntranetSubnetIdSet": null,
"IntranetVpcCidr": "",
"IntranetVpcId": "",
"LbVipIsp": "",
"LogDelivery": "",
"LogDeliveryArgs": "",
"ModuleSet": [],
"Nodes": 50,
"OpenClbId": "",
"OrgAccountQuota": 0,
"PackageBandwidth": 0,
"PackageIOABandwidth": 1,
"PackageIOAUserCount": 1,
"PackageNode": 0,
"PayMode": 1,
"Pid": 1010053,
"PrivateIpSet": [
"192.1*****.107"
],
"ProductCode": "p_cds_dasb",
"PublicIpSet": [
"114.1*****.171"
],
"RenewFlag": 0,
"ResourceEdition": "pro",
"ResourceId": "bh-saa*****wc5mj",
"ResourceName": "T-Sec-堡垒机（SaaS型）/专业版",
"ResourceZoneSet": [
{
"Region": "ap-g****zhou",
"SubnetCidrBlock": "192.1*****.0/24",
"SubnetId": "subne*****vnywk",
"SubnetName": "subnet6",
"SubnetUsageType": "DEPLOY",
"VpcCidrBlock": "192.1*****0/16",
"VpcId": "vpc-****50wz",
"VpcName": "gord****est1",
"Zone": "ap-gu*****ou-6"
}
],
"ShareClb": false,
"Status": 1,
"SubProductCode": "sp_cds_d********aas_pro",
"SubnetId": "subne*****vnywk",
"SubnetName": "sub**t6",
"SvArgs": "sv_cds_da*********ro_50node",
"TUICmdPort": 8300,
"TUIDirectPort": 8300,
"TimeSpan": 1,
"TimeUnit": "m",
"Trial": 0,
"UsedDomainCount": 0,
"UsedNodes": 1,
"VpcCidrBlock": "192.1*****0/16",
"VpcId": "vpc-****50wz",
"VpcName": "gord****est1",
"WebAccess": 1,
"Zone": "ap-gu*****ou-6"
}
],
"TotalCount": 18,
"RequestId": "7e4c4add-b3b2-4db0-8794-0953a4c3d9a9"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
