调用DescribeInstanceList查询防护包实例的详细信息_DDoS防护(Anti-DDoS)-阿里云帮助中心

查询DDoS原生防护实例的详情。

接口说明

本接口用于分页查询当前阿里云账号拥有的所有 DDoS 原生防护实例的详情，例如，实例的 ID、有效期、状态等。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用将会被限流，这可能影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-antiddosbag:DescribeInstanceList	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
ResourceGroupId	string	否	DDoS 原生防护实例在资源管理服务中所属的资源组 ID。不设置该参数表示默认资源组。	rg-acfm2pz25js****
InstanceIdList	string	否	要查询的 DDoS 原生防护实例的 ID 列表。使用`["<实例 ID 1>","<实例 ID 2>",……]`格式表示。	["ddosbgp-cn-oew1pjrk****"]
Remark	string	否	要查询的 DDoS 原生防护实例的备注。支持模糊查询。	test
PageNo	integer	是	分页查询时，设置当前页面的页码。	1
PageSize	integer	是	分页查询时，设置每页包含实例的数量。	10
IpVersion	string	否	要查询的 DDoS 原生防护实例防护的 IP 资产的协议类型。取值： IPv4：表示 IPv4 协议。 IPv6：表示 IPv6 协议。	IPv4
InstanceType	string	否	要查询的 DDoS 原生防护实例的防护套餐类型。取值： 0：表示专业版。 1：表示企业版。	0
Ip	string	否	要查询的 DDoS 原生防护实例的防护对象 IP。	47.89.XX.XX
Orderby	string	否	设置 DDoS 原生防护实例列表的排序字段。取值固定为 expireTime，表示按照实例的到期时间排序。您可以通过 Orderdire 参数设置排序方式。	expireTime
Orderdire	string	否	设置排序方式。取值： desc（默认）：表示按照到期时间降序排序。 asc：表示按照到期时间升序排序。	desc
RegionId	string	否	要查询的 DDoS 原生防护实例所在地域 ID。说明您可以调用 DescribeRegions 查询 DDoS 原生防护支持的所有地域 ID。	cn-hangzhou
Tag	array<object>	否	要查询的 DDoS 原生防护实例绑定的标签列表。
	object	否	要查询的 DDoS 原生防护实例绑定的标签列表。
Key	string	否	要查询的 DDoS 原生防护实例绑定的标签键。	test-key
Value	string	否	要查询的 DDoS 原生防护实例绑定的标签值。	test-value
InstanceTypeList	array	否	要查询的 DDoS 原生防护实例的防护套餐类型。
	string	否	要查询的 DDoS 原生防护实例的防护套餐类型。取值： 0：表示专业版。 1：表示企业版	0

调用 API 时，除了本文中该 API 的请求参数，还需加入阿里云 API 公共请求参数。公共请求参数的详细介绍，请参见公共参数。

调用 API 的请求格式，请参见本文示例中的请求示例。

返回参数

名称	类型	描述	示例值
	object
Total	long	查询到的 DDoS 原生防护实例的总数量。	1
RequestId	string	本次请求的 ID。	381D5D33-BB8F-395F-8EE4-AE3BB4B523C4
InstanceList	array<object>	DDoS 原生防护实例的详情列表。
Instance	object	DDoS 原生防护实例的详情列表。
Status	string	实例的状态。取值： 1：表示正常。 2：表示已过期。 3：表示已释放。	1
IpType	string	实例防护的 IP 资产的协议类型。取值： IPv4：表示 IPv4 协议。 IPv6：表示 IPv6 协议。	IPv4
AutoRenewal	boolean	实例是否已开启自动续费。取值： true：表示已开启。 false：表示未开启。	false
Remark	string	实例的备注。	test
ExpireTime	long	实例的到期时间。使用时间戳表示，单位：毫秒。	1640275200000
Product	string	实例关联的云产品类型。默认不返回该参数，只有当 DDoS 原生防护实例通过其他云产品创建时，才会返回对应云产品的代码。取值： gamebox：表示该 DDoS 原生防护实例通过游戏安全盒服务创建。 eip：表示该 DDoS 原生防护实例通过 DDoS 防护（增强版）EIP 实例创建。	gamebox
GmtCreate	long	实例的购买时间。使用时间戳表示，单位：毫秒。	1592886047000
InstanceId	string	实例 ID。	ddosbgp-cn-oew1pjrk****
InstanceType	string	实例的防护套餐类型。取值： 0：表示专业版。 1：表示企业版。	1
BlackholdingCount	string	实例防护的公网 IP 资产中，处于黑洞状态的 IP 的数量。说明您可以调用 DeleteBlackhole 为单个受保护 IP 解除黑洞状态。	0
CoverageType	integer	实例的资产覆盖类型。 1：表示支持全球多个地域的公网 IP 资产。 2：表示支持中国内地多个地域的公网 IP 资产。 3：表示支持非中国内地多个地域的公网 IP 资产。 4：表示支持全球一个地域的公网 IP 资产。	1
CommodityType	string	实例的商品类型。 ddos_ddosorigin_public_cn：表示 DDoS 原生防护 2.0（后付费）中国站。 ddos_ddosorigin_public_intl：表示 DDoS 原生防护 2.0（后付费）国际站。	ddos_ddosorigin_public_cn
AutoProtectCondition	object	自动绑定条件。
Events	array	自动绑定基于的事件。
events	string	自动绑定基于的事件。取值： any：表示基于清洗或者黑洞事件绑定。 clean：表示基于清洗事件自动绑定。 blackhole：表示基于黑洞事件自动绑定。	any

示例

正常返回示例

JSON格式

{
  "Total": 1,
  "RequestId": "381D5D33-BB8F-395F-8EE4-AE3BB4B523C4",
  "InstanceList": [
    {
      "Status": "1",
      "IpType": "IPv4",
      "AutoRenewal": false,
      "Remark": "test",
      "ExpireTime": 1640275200000,
      "Product": "gamebox",
      "GmtCreate": 1592886047000,
      "InstanceId": "ddosbgp-cn-oew1pjrk****",
      "InstanceType": "1",
      "BlackholdingCount": "0",
      "CoverageType": 1,
      "CommodityType": "ddos_ddosorigin_public_cn",
      "AutoProtectCondition": {
        "Events": [
          "any"
        ]
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-02-28	OpenAPI 返回结构发生变更	查看变更详情
2023-11-23	OpenAPI 返回结构发生变更	查看变更详情
2023-04-20	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情