API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心 > DDoS 防护 > 资产列表相关接口 > 获取高防IP资产实例列表

获取高防IP资产实例列表

最近更新时间：2024-03-12 01:08:03

我的收藏

本页目录：

1. 接口描述

接口请求域名： antiddos.tencentcloudapi.com 。

获取高防IP资产实例列表

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeListBGPIPInstances。
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搜索，例如，bgpip-00000001
示例值：bgpip-00000001
FilterLine 否 Integer 高防IP线路搜索，取值为[
1：BGP线路
2：电信
3：联通
4：移动
99：第三方合作线路
]
示例值：1
FilterRegion 否 String 地域搜索，例如，ap-guangzhou
示例值：ap-guangzhou
FilterName 否 String 名称搜索
示例值：test
FilterEipType 否 Integer 是否只获取高防弹性公网IP实例。填写时，只能填写1或者0。当填写1时，表示返回高防弹性公网IP实例。当填写0时，表示返回非高防弹性公网IP实例。
示例值：1
FilterEipEipAddressStatus.N 否 Array of String 高防弹性公网IP实例的绑定状态搜索条件，取值范围 [BINDING、 BIND、UNBINDING、UNBIND]。该搜索条件只在FilterEipType=1时才有效。
FilterDamDDoSStatus 否 Integer 是否只获取安全加速实例。填写时，只能填写1或者0。当填写1时，表示返回安全加速实例。当填写0时，表示返回非安全加速实例。
示例值：1
FilterStatus 否 String 获取特定状态的资源，运行中填idle，攻击中填attacking，封堵中填blocking，试用资源填trial
示例值：attacking
FilterCname 否 String 获取特定的实例Cname
示例值：abcdefg
FilterInstanceIdList.N 否 Array of String 批量查询实例ID对应的高防IP实例资源
FilterTag 否 TagFilter 标签搜索
FilterPackType.N 否 Array of String 按照套餐类型进行过滤
FilterConvoy 否 Integer 重保护航搜索

3. 输出参数

参数名称 类型 描述
Total Integer 总数
示例值：2
InstanceList Array of BGPIPInstance 高防IP资产实例列表
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取高防IP资产实例列表

输入示例

POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeListBGPIPInstances
<公共请求参数>

{
    "Limit": "1",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "RequestId": "0381c271-292d-4e2a-adcc-cd7bcd6977a7",
        "InstanceList": [
            {
                "InstanceDetail": {
                    "EipList": [
                        "2402:4e00:31:804::17"
                    ],
                    "InstanceId": "bgpip-00000001"
                },
                "SpecificationLimit": {
                    "ProtectBandwidth": 30000,
                    "ProtectCCQPS": 40000,
                    "ElasticBandwidth": 50000,
                    "NormalBandwidth": 1000,
                    "ForwardRulesLimit": 60,
                    "AutoRenewFlag": 0,
                    "Line": 1
                },
                "Usage": {
                    "PortRulesUsage": 0,
                    "DomainRulesUsage": 0,
                    "Last7DayAttackCount": 0
                },
                "Region": {
                    "Region": "ap-shanghai"
                },
                "PackInfo": null,
                "StaticPackRelation": null,
                "EipAddressPackRelation": null,
                "AnycastOutPackRelation": null,
                "Tgw": 2,
                "ZoneId": 0,
                "Name": "",
                "V6Flag": 1,
                "Domain": "",
                "Status": "idle",
                "ExpiredTime": "2023-01-08 21:22:24",
                "CreatedTime": "2022-12-08 21:22:24",
                "EipAddressStatus": "",
                "EipFlag": 0,
                "EipAddressInfo": null,
                "ConvoyId": "",
                "DamDDoSStatus": 0,
                "BGPIPChannelFlag": 0,
                "TagInfoList": [],
                "InstanceVersion": 3
            }
        ],
        "Total": 12
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
中国站