All Products
Search
Document Center

Anti-DDoS:DescribeWebInstanceRelations

Last Updated:Apr 16, 2024

Queries the information about Anti-DDoS Pro or Anti-DDoS Premium instances to which a website service is added.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-ddoscoo:DescribeWebInstanceRelationsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceGroupIdstringNo

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.

default
DomainsarrayYes

The domain names of the website. list

Note A forwarding rule must be configured for the domain name. You can call the DescribeDomains operation to query all domain names.
stringYes

The domain name of the website.

www.aliyun**.com

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

0222382B-5FE5-4FF7-BC9B-97EE31D58818
WebInstanceRelationsobject []

The information about the instances to which a website service is added.

Domainstring

The domain name of the website.

www.aliyun.com
InstanceDetailsobject []

The information about the instance to which a website service is added.

FunctionVersionstring

The function plan of the instance. Valid values:

  • default: Standard function plan
  • enhance: Enhanced function plan
enhance
InstanceIdstring

The ID of the instance.

ddoscoo-cn-0pp163pd****
EipListarray

The IP addresses of the instance.

string

The IP address of the instance.

203.***.***.158

Examples

Sample success responses

JSONformat

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

Error codes

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