查询DDoS高防实例的详情列表。
接口说明
本接口用于分页查询当前阿里云账号拥有的DDoS高防实例的详情,例如,实例的ID、版本、到期时间、业务转发状态等。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-ddoscoo:DescribeInstances | List |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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高防实例的防护套餐版本。取值:
| 9 |
Enabled | integer | 否 | 要查询的DDoS高防实例的业务流量转发状态。取值:
| 1 |
ExpireStartTime | long | 否 | 要查询的DDoS高防实例的最早到期时间(即查询到期时间在ExpireStartTime之后的DDoS高防实例)。使用时间戳表示,单位:毫秒。 | 1640361500000 |
ExpireEndTime | long | 否 | 要查询的DDoS高防实例的最晚到期时间(即查询到期时间在ExpireEndTime之前的DDoS高防实例)。使用时间戳表示,单位:毫秒。 | 1640361700000 |
InstanceIds | array | 否 | 要查询的DDoS高防实例的ID列表。 | |
string | 否 | 要查询的DDoS高防实例的ID。N的最大值:200,即最多可配置200个DDoS高防实例,实例ID之间用半角逗号(,)隔开。 | ddoscoo-cn-7pp2g9ed**** | |
Status | array | 否 | 要查询的DDoS高防实例的状态列表。 | |
integer | 否 | 要查询的DDoS高防实例的状态。N的最大值:2,即最多可配置2个DDoS高防实例状态,实例状态之间用半角逗号(,)隔开。取值:
| 1 | |
Tag | object [] | 否 | 要查询的DDoS高防实例绑定的标签。 | |
Key | string | 否 | 要查询的DDoS高防实例绑定的标签键。N的最大值:200,即最多可配置200个标签键。配置规则如下:
说明标签键(Key)和标签值(Value)必须成对出现。 | test-key |
Value | string | 否 | 要查询的DDoS高防实例绑定的标签值。N的最大值:200,即最多可配置200个标签值。配置规则如下:
说明标签键(Key)和标签值(Value)必须成对出现。 | test-value |
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回参数
示例
正常返回示例
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
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2023-05-17 | OpenAPI 返回结构发生变更 | |||
|