全部产品
Search
文档中心

DDoS 防护:DescribeInstanceDetails - 查询DDoS高防实例的IP和线路信息

更新时间:Jun 02, 2023

查询DDoS高防实例的IP和线路信息。

接口说明

本接口用于查询DDoS高防实例的IP和线路信息,例如,实例的IP地址、状态、防护线路等。

QPS限制

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

调试

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

调试

授权信息

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

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

请求参数

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

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

string

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

说明您可以调用DescribeInstanceIds查询所有DDoS高防实例的ID。
ddoscoo-cn-zvp2eibz****

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的ID。

3C814429-21A5-4673-827E-FDD19DC75681
InstanceDetailsobject []

DDoS高防实例的IP和线路信息。

Linestring

DDoS高防实例的防护线路。

coop-line-001
InstanceIdstring

DDoS高防实例ID。

ddoscoo-cn-zvp2eibz****
EipInfosobject []

DDoS高防实例的IP信息。

Statusstring

DDoS高防IP的状态。取值:

  • normal:表示正常。
  • expired:表示已过期。
  • defense:表示清洗中。
  • blackhole:表示黑洞中。
  • punished:表示处罚中。
normal
IpModestring

IP转发模式。取值:

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

DDoS高防IP地址。

203.117.XX.XX
IpVersionstring

IP协议版本。取值:

  • Ipv4:表示IPv4协议。
  • Ipv6:表示IPv6协议。
Ipv4

示例

正常返回示例

JSON格式

{
  "RequestId": "3C814429-21A5-4673-827E-FDD19DC75681",
  "InstanceDetails": [
    {
      "Line": "coop-line-001",
      "InstanceId": "ddoscoo-cn-zvp2eibz****",
      "EipInfos": [
        {
          "Status": "normal",
          "IpMode": "fnat",
          "Eip": "203.117.XX.XX",
          "IpVersion": "Ipv4"
        }
      ]
    }
  ]
}

错误码

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