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

查询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:DescribeInstanceDetailsget
  • 全部资源
    *

请求参数

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

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

string

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

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

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

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

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

3C814429-21A5-4673-827E-FDD19DC75681
InstanceDetailsarray<object>

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

InstanceDetailobject
Linestring

DDoS 高防实例的防护线路。

coop-line-001
InstanceIdstring

DDoS 高防实例 ID。

ddoscoo-cn-zvp2eibz****
EipInfosarray<object>

DDoS 高防实例的 IP 信息。

EipInfoobject
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
CertConfiguredboolean

是否配置了自定义证书。

true
TlsVersionstring

自定义配置的 TLS 版本。

tls1.2
Ssl13Enabledboolean

是否支持 TLS1.3 版本。

false
FunctionVersionstring

实例类型。

default

示例

正常返回示例

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",
          "CertConfigured": true,
          "TlsVersion": "tls1.2",
          "Ssl13Enabled": false,
          "FunctionVersion": "default"
        }
      ]
    }
  ]
}

错误码

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

变更历史

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