Queries the information of the Anti-DDoS Pro or Anti-DDoS Premium instances that are associated with websites.

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 DescribeWebInstanceRelations

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

Domains.N RepeatList Yes www.aliyun.com

The domain name of website N.

Note A forwarding rule must be configured for the domain name. You can call the DescribeDomains operation to query all domain names.
RegionId String No cn-hangzhou

The region ID of the instance. Valid values:

  • cn-hangzhou: mainland China, which indicates an Anti-DDoS Pro instance
  • ap-southeast-1: outside mainland China, which indicates an Anti-DDoS Premium instance
ResourceGroupId String No default

The ID of the resource group to which the instance belongs in Resource Management. This parameter is empty by default, which indicates that the instance belongs to the default resource group.

Response parameters

Parameter Type Example Description
RequestId String 0222382B-5FE5-4FF7-BC9B-97EE31D58818

The ID of the request.

WebInstanceRelations Array

Details about the instances that are associated with the website.

Domain String www.aliyun.com

The domain name of the website.

InstanceDetails Array

Details about an instance that is associated with the website.

EipList List 203.***. ***.158

The IP addresses of the instance.

FunctionVersion String enhance

The function plan of the instance. Valid values:

  • default: standard function plan
  • enhance: enhanced function plan
InstanceId String ddoscoo-cn-0pp163pd****

The ID of the instance.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeWebInstanceRelations
&Domains.1=www.aliyun.com
&<Common request parameters>

Sample success responses

XML format

<DescribeWebInstanceRelationsResponse>
      <RequestId>0222382B-5FE5-4FF7-BC9B-97EE31D58818</RequestId>
      <WebInstanceRelations>
            <InstanceDetails>
                  <EipList>203. ***. ***.158</EipList>
                  <InstanceId>ddoscoo-cn-0pp163pd****</InstanceId>
                  <FunctionVersion>enhance</FunctionVersion>
            </InstanceDetails>
            <InstanceDetails>
                  <EipList>203. ***. ***.38</EipList>
                  <InstanceId>ddoscoo-cn-45917cd3****</InstanceId>
                  <FunctionVersion>enhance</FunctionVersion>
            </InstanceDetails>
            <Domain>www.aliyun.com</Domain>
      </WebInstanceRelations>
</DescribeWebInstanceRelationsResponse>

JSON format

{
    "RequestId": "0222382B-5FE5-4FF7-BC9B-97EE31D58818",
    "WebInstanceRelations": [
        {
            "InstanceDetails": [
                {
                    "EipList": [
                        "203. ***. ***.158"
                    ],
                    "InstanceId": "ddoscoo-cn-0pp163pd****",
                    "FunctionVersion": "enhance"
                },
                {
                    "EipList": [
                        "203. ***. ***.38"
                    ],
                    "InstanceId": "ddoscoo-cn-45917cd3****",
                    "FunctionVersion": "enhance"
                }
            ],
            "Domain": "www.aliyun.com"
        }
    ]
}

Error codes

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