ListPolicyAttachment - Anti-DDoS - Alibaba Cloud Documentation Center

Lists the associations of mitigation policies.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-antiddosbag:ListPolicyAttachment

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PolicyId	string	No	The policy ID.	f38f6520-92b7-451e-b520-9ab3********
PolicyType	string	No	The type of the policy. Valid values: default: the default mitigation policy l3: an IP mitigation policy l4: a port-specific mitigation policy	l3
IpPortProtocolList	array<object>	No	A list of protected objects.
	object	No	A list of protected objects.
Ip	string	Yes	The IP address of the protected object.	47.118.172.***
Port	integer	No	The port number of the protected object.	8*
Protocol	string	No	The protocol type of the protected object. Valid values: tcp: Transmission Control Protocol (TCP). udp: User Datagram Protocol (UDP).	tcp
PortRange	string	No	The port range of the protected object.	8-9
PageNo	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page. The default value is 10.	10
PortVersion	string	No	The version of the port-specific mitigation policy. Valid values: Leave this parameter empty: queries the policy attachments of the default Surf deep packet inspection (DPI) engine. 2: queries the policy attachments of the new Stream DPI engine.	2

Response elements

Element	Type	Description	Example
	object	The response message.
RequestId	string	The ID of the request. This ID is unique to each request and is generated by Alibaba Cloud. You can use this ID to troubleshoot issues.	B4B379C2-9319-4C6B-B579-FE36831B09F4
AttachmentList	array<object>	A list of mitigation policy associations.
	object	A list of mitigation policy associations.
Ip	string	The IP address of the protected object.	147.139.183.***
PolicyId	string	The policy ID.	1b43f44e-65e1-411a-b0c0-d6c1********
PolicyName	string	The policy name.	test**
PolicyType	string	The type of the policy. Valid values: l3: an IP mitigation policy l4: a port-specific mitigation policy	l3
Region	string	The region where the IP address of the protected object is located.	cn-hangzhou
Port	integer	The port number of the protected object.	8*
Protocol	string	The protocol type of the protected object. Valid values: tcp: Transmission Control Protocol. udp: User Datagram Protocol.	udp
MemberUid	string	The UID of the member account to which the IP address of the protected object belongs.	177699790631****
PolicyRemark	string	The remarks of the policy.	test
PortRange	string	The port range of the protected object.	8-9
Total	integer	The total number of mitigation policy associations.	28

Examples

Success response

JSON format

{
  "RequestId": "B4B379C2-9319-4C6B-B579-FE36831B09F4",
  "AttachmentList": [
    {
      "Ip": "147.139.183.***",
      "PolicyId": "1b43f44e-65e1-411a-b0c0-d6c1********",
      "PolicyName": "test**",
      "PolicyType": "l3",
      "Region": "cn-hangzhou",
      "Port": 0,
      "Protocol": "udp",
      "MemberUid": "177699790631****",
      "PolicyRemark": "test",
      "PortRange": "8*-9*"
    }
  ],
  "Total": 28
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.