全部产品
Search
文档中心

DDoS 防护:DescribeInstanceIds - 查询DDoS高防实例的ID信息

更新时间:May 14, 2024

查询DDoS高防实例的ID、版本、备注、IP类型信息。

接口说明

本接口用于查询所有 DDoS 高防实例的 ID、版本、备注、IP 类型信息。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ResourceGroupIdstring

DDoS 高防实例在资源管理服务中所属的资源组 ID。

不设置该参数表示默认资源组。

rg-acfm2pz25js****
Editioninteger

要查询的 DDoS 高防实例的类型。取值:

  • 0:表示 DDoS 高防(非中国内地)保险版。
  • 1:表示 DDoS 高防(非中国内地)无忧版。
  • 2:表示 DDoS 高防(非中国内地)加速线路。
  • 3:表示 DDoS 高防(非中国内地)安全加速线路。
  • 9:表示 DDoS 高防(中国内地)专业版。
9
InstanceIdsarray

要查询的 DDoS 高防实例的 ID 列表。N 的最大值:200。

string

要查询的 DDoS 高防实例的 ID。

不设置该参数表示查询所有 DDoS 高防实例。

ddoscoo-cn-zvp2eibz****

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

310A41FD-0990-5610-92E0-A6A55D7C6444
InstanceIdsobject []

DDoS 高防实例的 ID、版本、备注、IP 类型信息。

IpModestring

实例的 IP 转发模式。取值:

  • fnat:表示源站和客户端的 IP 版本一致,即 IPv4 地址客户端请求转发到 IPv4 地址源站、IPv6 地址客户端请求转发到 IPv6 地址源站。
  • v6tov4:表示 IPv6 和 IPv4 地址客户端请求都转发到 IPv4 地址源站。
fnat
Editioninteger

实例的类型。取值:

  • 0:表示 DDoS 高防(非中国内地)保险版。
  • 1:表示 DDoS 高防(非中国内地)无忧版。
  • 2:表示 DDoS 高防(非中国内地)加速线路。
  • 3:表示 DDoS 高防(非中国内地)安全加速线路。
  • 9:表示 DDoS 高防(中国内地)专业版。
9
InstanceIdstring

实例 ID。

ddoscoo-cn-zvp2eibz****
IpVersionstring

实例的 IP 协议版本。取值:

  • Ipv4:表示 IPv4 版本。
  • Ipv6:表示 IPv6 版本。
Ipv4
Remarkstring

实例的备注。

test

示例

正常返回示例

JSON格式

{
  "RequestId": "310A41FD-0990-5610-92E0-A6A55D7C6444",
  "InstanceIds": [
    {
      "IpMode": "fnat",
      "Edition": 9,
      "InstanceId": "ddoscoo-cn-zvp2eibz****",
      "IpVersion": "Ipv4",
      "Remark": "test"
    }
  ]
}

错误码

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