Queries the IP addresses and Internet service provider (ISP) lines of Anti-DDoS Pro or Anti-DDoS Premium instances.

Usage notes

You can call this operation to query the information about the IP addresses and ISP lines of Anti-DDoS Pro or Anti-DDoS Premium instances. The information includes the IP address, status, and protection line.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeInstanceDetails

The operation that you want to perform. Set the value to DescribeInstanceDetails.

RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: Chinese mainland, which indicates an Anti-DDoS Pro instance. This is the default value.
  • ap-southeast-1: outside the Chinese mainland, which indicates an Anti-DDoS Premium instance.
InstanceIds.N String Yes ddoscoo-cn-zvp2eibz****

The ID of the instance to query.

Note You can call the DescribeInstanceIds operation to query the IDs of all instances.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String 3C814429-21A5-4673-827E-FDD19DC75681

The ID of the request.

InstanceDetails Array of InstanceDetail

The IP address and ISP line information about the instance.

Line String coop-line-001

The protection line of the instance.

InstanceId String ddoscoo-cn-zvp2eibz****

The ID of the instance.

EipInfos Array of EipInfo

The information about the IP address of the instance.

Status String normal

The status of the instance. Valid values:

  • normal: normal
  • expired: expired
IpMode String fnat

The IP address-based forwarding mode of the instance. Valid values:

  • fnat: Requests from IPv4 addresses are forwarded to origin servers that use IPv4 addresses and requests from IPv6 addresses are forwarded to origin servers that use IPv6 addresses.
  • v6tov4: All requests are forwarded to origin servers that use IPv4 addresses.
Eip String 203.117.XX.XX

The IP address of the instance.

IpVersion String Ipv4

The IP version of the protocol. Valid values:

  • Ipv4: IPv4
  • Ipv6: IPv6

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeInstanceDetails
&InstanceIds=["ddoscoo-cn-zvp2eibz****"]
&Common request parameters

Sample success responses

XML format 

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 format 

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"
    } ]
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.