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

使用说明

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

QPS限制

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeInstanceDetails

要执行的操作。取值:DescribeInstanceDetails

RegionId String cn-hangzhou

DDoS高防实例所属地域ID。取值:

  • cn-hangzhou(默认):表示中国内地,即DDoS高防(新BGP)实例。
  • ap-southeast-1:表示非中国内地,即DDoS高防(国际)实例。
InstanceIds.N String ddoscoo-cn-zvp2eibz****

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

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

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

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

返回数据

名称 类型 示例值 描述
RequestId String 3C814429-21A5-4673-827E-FDD19DC75681

本次请求的ID。

InstanceDetails Array of InstanceDetail

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

Line String coop-line-001

DDoS高防实例的防护线路。

InstanceId String ddoscoo-cn-zvp2eibz****

DDoS高防实例ID。

EipInfos Array of EipInfo

DDoS高防实例的IP信息。

Status String normal

DDoS高防IP的状态。取值:

  • normal:表示正常。
  • expired:表示已过期。
IpMode String fnat

IP转发模式。取值:

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

DDoS高防IP地址。

IpVersion String Ipv4

IP协议版本。取值:

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstanceDetails
&InstanceIds=["ddoscoo-cn-zvp2eibz****"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceDetailsResponse>
    <RequestId>3C814429-21A5-4673-827E-FDD19DC75681</RequestId>
    <InstanceDetails>
        <Line>coop-line-001</Line>
        <InstanceId>ddoscoo-cn-mp91j1ao****</InstanceId>
        <EipInfos>
            <Status>normal</Status>
            <IpMode>fnat</IpMode>
            <Eip>203.117.XX.XX</Eip>
            <IpVersion>Ipv4</IpVersion>
        </EipInfos>
    </InstanceDetails>
</DescribeInstanceDetailsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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