DescribeInstanceDetails - Anti-DDoS - Alibaba Cloud Documentation Center

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

Operation description

You can call the DescribeInstanceDetails operation to query the information about the IP addresses and ISP lines of the 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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribeInstanceDetails	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	array	Yes	An array that consists of the IDs of instances to query.
	string	Yes	The ID of the instance to query. Note You can call the DescribeInstanceIds operation to query the IDs of all instances.	ddoscoo-cn-zvp2eibz****

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	Description	Example
	object
RequestId	string	The request ID.	3C814429-21A5-4673-827E-FDD19DC75681
InstanceDetails	array<object>	The IP address and ISP line information about the Anti-DDoS Proxy instance.
InstanceDetail	object
Line	string	The protection line of the instance.	coop-line-001
InstanceId	string	The ID of the instance.	ddoscoo-cn-zvp2eibz****
EipInfos	array<object>	The IP address information about the Anti-DDoS Proxy instance.
EipInfo	object
Status	string	The status of the instance. Valid values: normal: indicates that the instance is normal. expired: indicates that the instance expired. defense: indicates that traffic scrubbing is performed on the asset that is protected by the instance. blackhole: indicates that blackhole filtering is triggered for the asset that is protected by the instance. punished: indicates that the instance is in penalty.	normal
IpMode	string	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.	fnat
Eip	string	The IP address of the instance.	203.117.XX.XX
IpVersion	string	The IP version of the protocol. Valid values: Ipv4: IPv4 Ipv6: IPv6	Ipv4
CertConfigured	boolean	Indicates whether a custom certificate is configured.	true
TlsVersion	string	The Transport Layer Security (TLS) version that is configured.	tls1.2
Ssl13Enabled	boolean	Indicates whether the TLS 1.3 version is supported.	false
FunctionVersion	string	The type of the instance.	default

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-06-06	The response structure of the API has changed	View Change Details