DescribeCloudResourceList - Web Application Firewall - Alibaba Cloud Documentation Center

Queries a list of resources added to Web Application Firewall (WAF) in cloud native mode.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to query the ID of the WAF instance.	waf_elasticity-cn-0xldbqt****
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q
OwnerUserId	string	No	The UID of the resource owner.	1111111111
ResourceInstanceId	string	No	The ID of the resource instance.	i-8vbdlsd********81e22
Port	string	No	The port of the cloud service that is added to WAF.	80
ResourceProduct	string	No	The cloud service to which the resource belongs. Valid values: alb: Application Load Balancer (ALB). mse: Microservices Engine (MSE). fc: Function Compute (FC). sae: Serverless App Engine (SAE). ecs: Elastic Compute Service (ECS). clb4: Classic Load Balancer (CLB) that uses the TCP protocol. clb7: CLB that uses the HTTP or HTTPS protocol. apig: API Gateway (APIG). nlb: Network Load Balancer (NLB). Note Not all cloud services are available in all regions. If you specify this parameter, make sure that the specified cloud service is available in the selected region. Otherwise, the request may fail.	ecs
CloudResourceId	string	No	The ID of the protected resource. WAF automatically generates this ID after you add the resource to WAF. Note Call CreateCloudResource to add a resource. Then, view the resource ID in the response.	i-8vbdlsd********81e22-80-ecs
NextToken	string	No	The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request. Note If a value is returned for this parameter, it indicates that a next page is available. To retrieve the next page of data, include the returned NextToken in your next request. Repeat this process until no value is returned, which indicates that all data has been retrieved.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 10.	10
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou

Region ID	Region name	Supported products
cn-hangzhou	China (Hangzhou)	SAE,ALB,FC,MSE,ECS,CLB,NLB
cn-shanghai	China (Shanghai)	SAE,ALB,FC,MSE,ECS,CLB,NLB
cn-shenzhen	China (Shenzhen)	SAE,ALB,FC,MSE,ECS,CLB,NLB
cn-beijing	China (Beijing)	SAE,ALB,FC,MSE,ECS,CLB,NLB
cn-zhangjiakou	China (Zhangjiakou)	SAE,ALB,FC,MSE,ECS,CLB,NLB
cn-chengdu	China (Chengdu)	ALB,ECS,CLB,NLB
cn-qingdao	China (Qingdao)	ALB,ECS,CLB,NLB
cn-guangzhou	China (Guangzhou)	ALB
cn-wulanchabu	China (Ulanqab)	ALB
cn-hongkong	China (Hong Kong)	ALB,MSE,ECS,CLB,NLB
cn-fuzhou	China (Fuzhou) - local region - being decommissioned	ALB
ap-southeast-6	Philippines (Manila)	ALB
ap-southeast-5	Indonesia (Jakarta)	ALB,ECS,CLB,NLB
ap-northeast-1	Japan (Tokyo)	ALB
ap-southeast-3	Malaysia (Kuala Lumpur)	ALB,MSE,ECS,CLB,NLB
ap-southeast-1	Singapore	ALB,MSE
eu-central-1	Germany (Frankfurt)	ALB
us-west-1	US (Silicon Valley)	ALB
us-east-1	US (Virginia)	ALB

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	F35F45B0-5D6B-4238-BE02-A62D****E840
NextToken	string	The token that is used to retrieve the next page of results. Note If a value is returned for this parameter, it indicates that a next page is available. To retrieve the next page of data, include the returned NextToken in your next request. Repeat this process until no value is returned, which indicates that all data has been retrieved.	AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
TotalCount	integer	The total number of entries returned.	118
MaxResults	integer	The number of entries returned on the current page.	20
CloudResourceList	array<object>	The list of resources that are added to WAF.
	object	The resource that is added to WAF.
Protocol	string	The protocol type. Valid values: http: HTTP https: HTTPS	http
Port	integer	The port of the cloud service that is added to WAF.	80
ResourceRegionId	string	The ID of the region where the resource resides. For more information, see the "Regions and supported products" section in this topic.	cn-hangzhou
ResourceInstanceId	string	The ID of the instance that is added to WAF.	i-8vbdlsd********81e22
ResourceProduct	string	The cloud service to which the resource belongs. Valid values: alb: ALB. mse: MSE. fc: FC. sae: SAE. ecs: ECS. clb4: CLB that uses the TCP protocol. clb7: CLB that uses the HTTP or HTTPS protocol. nlb: NLB.	ecs
CloudResourceId	string	The ID of the protected resource. This ID is automatically generated by WAF.	i-8vbdlsd********81e22-80-ecs
ResourceManagerResourceGroupId	string	The ID of the Alibaba Cloud resource group.	rg-aek2uo2****lbka

Examples

Success response

JSON format

{
  "RequestId": "F35F45B0-5D6B-4238-BE02-A62D****E840",
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "TotalCount": 118,
  "MaxResults": 20,
  "CloudResourceList": [
    {
      "Protocol": "http",
      "Port": 80,
      "ResourceRegionId": "cn-hangzhou",
      "ResourceInstanceId": "i-8vbdlsd********81e22",
      "ResourceProduct": "ecs",
      "CloudResourceId": "i-8vbdlsd********81e22-80-ecs",
      "ResourceManagerResourceGroupId": "rg-aek2uo2****lbka"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Waf.Instance.ValidFaild	WAF instance check failed. Check whether the instance ID is correct.	WAF instance check failed. Check whether the instance ID is correct.
400	Waf.Pullin.CloudProductParamEmpty	The resource Id of the cloud product accessing WAF is null or null values exist in the three input parameters of the cloud product name, port, and cloud product instance.	The resource Id of the cloud product accessing WAF is null or null values exist in the three input parameters of the cloud product name, port, and cloud product instance.
400	Waf.Pullin.CloudResourceInvalid	CloudResourceId parameter is illegal.	CloudResourceId parameter is illegal

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.