1. 接口描述
接口请求域名: dasb.tencentcloudapi.com 。
查询用户购买的堡垒机服务信息,包括资源ID、授权点数、VPC、过期时间等。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeResources。 |
Version | 是 | String | 公共参数,本接口取值:2019-10-18。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ApCode | 否 | String | 地域码, 如: ap-guangzhou 示例值:ap-guangzhou |
VpcId | 否 | String | 按照堡垒机开通的 VPC 实例ID查询 示例值:vpc-sasafadsaasd |
ResourceIds.N | 否 | Array of String | 资源ID集合,当传入ID集合时忽略 ApCode 和 VpcId 示例值:["bh-saas-sdaeweas"] |
Limit | 否 | Integer | 每页条目数量 示例值:20 |
Offset | 否 | Integer | 分页偏移位置 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ResourceSet | Array of Resource | 堡垒机资源列表 示例值:[{"ResourceId":"bh-saas-s3ed4r5e"}] |
TotalCount | Integer | 堡垒机资源数量 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询资源信息
查询用户购买的资源信息,包括资源ID,授权点数,vpc,过期时间等。
输入示例
POST / HTTP/1.1
Host: dasb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResources
<公共请求参数>
{
"ApCode": "ap-guangzhou",
"VpcId": "vpc-eawasddsd",
"ResourceIds": [
"bh-sass-wfsddff"
],
"Limit": 1,
"Offset": 1
}
输出示例
{
"Response": {
"RequestId": "rid-test",
"ResourceSet": [
{
"RenewFlag": 1,
"Zone": "ap-guangzhou-6",
"SubnetName": "subnet-test",
"Nodes": 1,
"Status": 1,
"VpcId": "vpc-test",
"SubProductCode": "sp_cds_dasb_bh_saas",
"ResourceId": "bh-saas-test",
"PackageBandwidth": 1,
"VpcName": "vpc-test",
"ApCode": "ap-guangzhou",
"SubnetId": "subnet-test",
"ResourceName": "T-Sec-堡垒机(SaaS型)/专业版",
"Expired": true,
"Deployed": true,
"ProductCode": "p_cds_dasb",
"PublicIpSet": [
"1.1.1.1"
],
"ModuleSet": [
"DB"
],
"ExtendPoints": 1,
"UsedNodes": 1,
"PrivateIpSet": [
"1.1.1.1"
],
"Pid": 1,
"VpcCidrBlock": "192.168.0.0/16",
"PackageNode": 1,
"ExpireTime": "2020-09-22T00:00:00+00:00",
"SvArgs": "sv_cds_dasb_saas_free_2node",
"CidrBlock": "192.168.11.0/24",
"CreateTime": "2020-09-22T00:00:00+00:00",
"LogDeliveryArgs": "sv_cds_dasb_saas_sdwedfsgdf"
}
]
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |