调用DescribeInstances分页查询新BGP高防实例信息列表_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-ddoscoo:DescribeInstances	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
ResourceGroupId	string	否	DDoS 高防实例在资源管理服务中所属的资源组 ID。不设置该参数表示默认资源组。	rg-acfm2pz25js****
PageNumber	string	是	分页查询时，设置当前页面的页码。	1
PageSize	string	是	分页查询时，设置每页包含实例的数量。取值范围：1~50。	10
Ip	string	否	要查询的 DDoS 高防实例的 IP 地址。	203.107.XX.XX
Remark	string	否	要查询的 DDoS 高防实例的备注。支持模糊查询。	doc-test
Edition	integer	否	要查询的 DDoS 高防实例的防护套餐版本。取值： 0：表示 DDoS 高防（非中国内地）保险版。 1：表示 DDoS 高防（非中国内地）无忧版。 2：表示 DDoS 高防（非中国内地）加速线路。 9：表示 DDoS 高防（中国内地）专业版。	9
Enabled	integer	否	要查询的 DDoS 高防实例的业务流量转发状态。取值： 0：表示已停止转发业务流量。 1：表示正常转发业务流量。	1
ExpireStartTime	long	否	要查询的 DDoS 高防实例的最早到期时间（即查询到期时间在 ExpireStartTime 之后的 DDoS 高防实例）。使用时间戳表示，单位：毫秒。	1640361500000
ExpireEndTime	long	否	要查询的 DDoS 高防实例的最晚到期时间（即查询到期时间在 ExpireEndTime 之前的 DDoS 高防实例）。使用时间戳表示，单位：毫秒。	1640361700000
InstanceIds	array	否	要查询的 DDoS 高防实例的 ID 列表。最多可配置 200 个 DDoS 高防实例。
	string	否	要查询的 DDoS 高防实例的 ID。	ddoscoo-cn-7pp2g9ed****
Status	array	否	要查询的 DDoS 高防实例的状态列表。最多可配置 2 个 DDoS 高防实例状态。
	integer	否	要查询的 DDoS 高防实例的状态。取值： 1：表示正常。 2：表示已过期。	1
Tag	array<object>	否	要查询的 DDoS 高防实例绑定的标签列表。
	object	否
Key	string	否	要查询的 DDoS 高防实例绑定的标签键。N 的最大值：200，即最多可配置 200 个标签键。配置规则如下：每个标签包含一个标签键（Key）和一个标签值（Value），中间用半角逗号（,）隔开。标签之间用半角逗号（,）隔开。说明标签键（Key）和标签值（Value）必须成对出现。	test-key
Value	string	否	要查询的 DDoS 高防实例绑定的标签值。N 的最大值：200，即最多可配置 200 个标签值。配置规则如下：每个标签包含一个标签键（Key）和一个标签值（Value），中间用半角逗号（,）隔开。标签之间用半角逗号（,）隔开。说明标签键（Key）和标签值（Value）必须成对出现。	test-value

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

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

返回参数

名称	类型	描述	示例值
	object
TotalCount	long	查询到的 DDoS 高防实例的总数量。	1
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	A0AF40CC-814A-5A86-AEAA-6F19E88B8A39
Instances	array<object>	DDoS 高防实例的详情列表。
Instance	object
Status	integer	实例的状态。取值： 1：表示正常。 2：表示已过期。	1
IpMode	string	实例的 IP 转发模式。取值： fnat：表示源站和客户端的 IP 版本一致，即 IPv4 地址客户端请求转发到 IPv4 地址源站、IPv6 地址客户端请求转发到 IPv6 地址源站。 v6tov4：表示 IPv6 地址客户端请求转发到 IPv4 地址源站。	fnat
DebtStatus	integer	实例的欠费状态。取值固定为 0，表示不欠费，因为 DDoS 高防服务目前只支持包年包月的预付费计费方式。	0
Edition	integer	实例的防护套餐版本。取值： 0：表示 DDoS 高防（非中国内地）保险版。 1：表示 DDoS 高防（非中国内地）无忧版。 2：表示 DDoS 高防（非中国内地）加速线路。 9：表示 DDoS 高防（中国内地）专业版。	9
IpVersion	string	实例的 IP 协议版本。取值： Ipv4：表示 IPv4 协议。 Ipv6：表示 IPv6 协议。	Ipv4
ExpireTime	long	实例的到期时间。使用时间戳表示，单位：毫秒。	1640361600000
Remark	string	实例的备注。	doc-test
CreateTime	long	实例的创建时间。使用时间戳表示，单位：毫秒。	1637751953000
Enabled	integer	实例的业务流量转发状态。取值： 0：表示已停止转发业务流量。 1：表示正常转发业务流量。	1
InstanceId	string	实例的 ID。	ddoscoo-cn-7pp2g9ed****
IsFirstOpenBw	long	实例是否开启过 95 弹性业务带宽计费模式。取值： 0：表示未开启过。 1：表示开启过。	0
IsFirstOpenQps	long	实例是否开启过 95 弹性 QPS 计费模式。取值： 0：表示未开启过。 1：表示开启过。	0
Ip	string	DDoS 高防实例的 IP。	203.199.XX.XX

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "A0AF40CC-814A-5A86-AEAA-6F19E88B8A39",
  "Instances": [
    {
      "Status": 1,
      "IpMode": "fnat",
      "DebtStatus": 0,
      "Edition": 9,
      "IpVersion": "Ipv4",
      "ExpireTime": 1640361600000,
      "Remark": "doc-test",
      "CreateTime": 1637751953000,
      "Enabled": 1,
      "InstanceId": "ddoscoo-cn-7pp2g9ed****",
      "IsFirstOpenBw": 0,
      "IsFirstOpenQps": 0,
      "Ip": "203.199.XX.XX"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-06-30	OpenAPI 返回结构发生变更	查看变更详情
2023-05-17	OpenAPI 返回结构发生变更	查看变更详情