1. 接口描述
接口请求域名: antiddos.tencentcloudapi.com 。
获取高防包资产实例列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeListBGPInstances。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-09。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Offset | 是 | Integer | 页起始偏移,取值为(页码-1)*一页条数 示例值:0 |
Limit | 是 | Integer | 一页条数,当Limit=0时,默认一页条数为20;最大取值为100 示例值:25 |
FilterIp | 否 | String | IP搜索 示例值:1.1.1.1 |
FilterInstanceId | 否 | String | 资产实例ID搜索,例如,bgp-00000001 示例值:bgp-00000001 |
FilterRegion | 否 | String | 地域搜索,例如,ap-guangzhou 示例值:ap-guangzhou |
FilterName | 否 | String | 名称搜索 示例值:name |
FilterLine | 否 | Integer | 按照线路搜索, 1: BGP; 2: 三网 示例值:1 |
FilterStatus | 否 | String | 状态搜索,idle:运行中;attacking:攻击中;blocking:封堵中 示例值:attacking |
FilterBoundStatus | 否 | String | 高防包绑定状态搜索,bounding:绑定中; failed:绑定失败 示例值:bounding |
FilterInstanceIdList.N | 否 | Array of String | 实例id数组 示例值:[bgp-00000001] |
FilterEnterpriseFlag | 否 | Integer | 企业版搜索, 1:包含重保护航套餐下的企业版列表, 2: 不包含重保护航套餐的企业版列表 示例值:1 |
FilterLightFlag | 否 | Integer | 轻量版搜索 示例值:1 |
FilterChannelFlag | 否 | Integer | 定制版搜索 示例值:1 |
FilterTag | 否 | TagFilter | 标签搜索 |
FilterTrialFlag | 否 | Integer | 试用资源搜索,1: 应急防护资源;2:PLG试用资源 示例值:1 |
FilterConvoy | 否 | Integer | 重保护航搜索 示例值:1 |
ExcludeAdvancedInfo | 否 | Boolean | 默认false;接口传true,返回数据中不包含高级信息,高级信息包含:InstanceList[0].Usage。 示例值:false |
FilterAssetIpList.N | 否 | Array of String | 资产IP数组 示例值:[1.1.1.1] |
FilterBasicPlusFlag | 否 | Integer | 是否包含基础防护增强版 0: 不包含 1: 包含 示例值:1 |
FilterPlanCntFlag | 否 | Integer | 是否标准版2.0 0: 包含标准版2.0 0 1: 只查询标准版2.0 0 2: 不查标准版2.0 示例值:1 |
FilterTransRegionFlag | 否 | Integer | 是否跨区域产品 0: 不包含跨区域产品 1: 中国大陆跨区域产品 2: 非中国大陆跨区域产品 3: 包含全部 示例值:0 |
FilterZoneIdList.N | 否 | Array of Integer | zoenid列表 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 总数 示例值:1 |
InstanceList | Array of BGPInstance | 高防包资产实例列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取高防包资产实例列表
获取高防包资产实例列表
输入示例
输出示例
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |