DescribeApisecMatchedHosts - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the list of domain names that are protected by API security.

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-waf:DescribeApisecMatchedHosts

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call the DescribeInstance operation to view the ID of the current WAF instance.	waf_v2_public_cn-x0r37plpl0g
MatchedHost	string	No	The domain name or IP address.	bc.aliyun.com
PageNumber	string	No	The number of the page to return for a paged query. Default value: 1.	1
PageSize	string	No	The number of entries to return on each page for a paged query. Default value: 10.	8
Type	string	No	The detection type. Valid values: api: the list of domain names for API assets. abnormal: the list of domain names that have threats. event: the list of domain names that have management events.	event
ClusterId	string	No	The ID of the hybrid cloud cluster. Note This parameter is used only in hybrid cloud scenarios. Call the DescribeHybridCloudClusters operation to obtain information about hybrid cloud clusters.	433
RegionId	string	No	The region of the WAF instance. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-aekz5qqo7jthcsa

Response elements

Element	Type	Description	Example
	object	The result of the request.
TotalCount	string	The total number of entries returned.	2
RequestId	string	The ID of the request.	8D4CA088-F72B-5658-BD5B-ECE8B8F0C7BB
Data	array<object>	The list of domain names.
	object	The information about the domain name.
MatchedHost	string	The domain name or IP address.	bc.aliyun.com
Count	integer	The number of queries.	31

Examples

Success response

JSON format

{
  "TotalCount": "2",
  "RequestId": "8D4CA088-F72B-5658-BD5B-ECE8B8F0C7BB",
  "Data": [
    {
      "MatchedHost": "bc.aliyun.com",
      "Count": 31
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.