DescribeApisecMatchedHosts - - Alibaba Cloud Documentation Center

Queries the list of domain names detected in the API security module.

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-waf:DescribeApisecMatchedHosts	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Region	string	No	The region in which the Web Application Firewall (WAF) instance is deployed. Valid values: cn (default): Chinese mainland. cn-hongkong: outside the Chinese mainland.	cn
InstanceId	string	Yes	The ID of the Web Application Firewall (WAF) instance. Note You can call the DescribeInstance operation to query the ID of the WAF instance.	waf_v2_public_cn-x0r37plpl0g
MatchedHost	string	No	The domain name or IP address.	bc.aliyun.com
PageNumber	string	No	The page number. Default value: 1.	1
PageSize	string	No	The number of entries per page. Default value: 10.	8
Type	string	No	The detection type. Valid values: api: API-related domain names abnormal: risk-related domain names event: security event-related domain names	event
ClusterId	string	No	The ID of the hybrid cloud cluster. Note For hybrid cloud scenarios only, you can call the DescribeHybridCloudClusters operation to query the hybrid cloud clusters.	433
RegionId	string	No	The region in which the WAF instance is deployed. Valid values: cn-hangzhou: 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 parameters

Parameter	Type	Description	Example
	object	The response parameters.
TotalCount	string	The total number of entries returned.	2
RequestId	string	The request ID.	8D4CA088-F72B-5658-BD5B-ECE8B8F0C7BB
Data	array<object>	The domain names.
matchdeHosts	object	The domain name.
MatchedHost	string	The domain name or IP address.	bc.aliyun.com
Count	long	The number of APIs related to the domain name.	31

Examples

Sample success responses

JSONformat

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

Error codes

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