DescribeInstances_新BGP高防IP_API文档-阿里云OpenAPI开发者门户

接口说明

本接口用于分页查询当前阿里云账号拥有的 DDoS 高防实例的详情，例如，实例的 ID、版本、到期时间、业务转发状态等。

QPS 限制

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

yundun-ddoscoo:DescribeInstances	Get	全部资源 *	无	无

请求参数

字段名称	字段详情
ResourceGroupIdstring	DDoS 高防实例在资源管理服务中所属的资源组 ID。展开详情示例值:rg-acfm2pz25js****
PageNumberstring	分页查询时，设置当前页面的页码。示例值:1
PageSizestring	分页查询时，设置每页包含实例的数量。取值范围：1~50。示例值:10
Ipstring	要查询的 DDoS 高防实例的 IP 地址。示例值:203.107.XX.XX
Remarkstring	要查询的 DDoS 高防实例的备注。支持模糊查询。示例值:doc-test
Editioninteger<int32>	要查询的 DDoS 高防实例的防护套餐版本。取值：展开详情示例值:9
Enabledinteger<int32>	要查询的 DDoS 高防实例的业务流量转发状态。取值：展开详情示例值:1
ExpireStartTimeinteger<int64>	要查询的 DDoS 高防实例的最早到期时间（即查询到期时间在 ExpireStartTime 之后的 DDoS 高防实例）。使用时间戳表示，单位：毫秒。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1640361500000
ExpireEndTimeinteger<int64>	要查询的 DDoS 高防实例的最晚到期时间（即查询到期时间在 ExpireEndTime 之前的 DDoS 高防实例）。使用时间戳表示，单位：毫秒。注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1640361700000
InstanceIdsarray<string>	要查询的 DDoS 高防实例的 ID 列表。最多可配置 200 个 DDoS 高防实例。子级条数 <= 100
Statusarray<integer<int32>>	要查询的 DDoS 高防实例的状态列表。最多可配置 2 个 DDoS 高防实例状态。子级条数 <= 10
Tagarray<object>	要查询的 DDoS 高防实例绑定的标签列表。子级条数 <= 20

请求说明

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

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

返回参数

字段名称	字段详情
TotalCountinteger<int64>	查询到的 DDoS 高防实例的总数量。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:1
RequestIdstring	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。示例值:A0AF40CC-814A-5A86-AEAA-6F19E88B8A39
Instancesarray<object>	DDoS 高防实例的详情列表。

DescribeInstances_新BGP高防IP_API文档