DescribeCloudResources - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the list of cloud services added to Web Application Firewall (WAF).

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:DescribeCloudResources

list

*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 query the ID of the WAF instance.	waf_v3prepaid_public_cn-lbj****cn0c
ResourceInstanceId	string	No	The ID of the resource instance.	alb-43glijk0fr****gths
ResourceName `deprecated`	string	No	The name of the resource instance.	alb-name
ResourceRegionId	string	No	The ID of the region where the resource resides. For more information, see the "Regions and supported products" section in this topic. Note Each cloud service supports different regions. If you specify the ResourceProduct parameter, make sure the region you specify for this parameter supports that service. Otherwise, the query may fail.	cn-beijing
ResourceProduct	string	No	The cloud service to which the resource belongs. By default, instances of Application Load Balancer (ALB), Microservices Engine (MSE), Function Compute (FC), and Serverless App Engine (SAE) are returned. Valid values: alb: ALB mse: MSE fc: FC sae: SAE ecs: Elastic Compute Service (ECS) clb4: Classic Load Balancer (CLB) that uses TCP clb7: CLB that uses HTTP or HTTPS nlb: Network Load Balancer (NLB) Note Each cloud service supports different regions. If you specify this parameter, make sure the region you specify for the ResourceRegionId parameter supports this service. Otherwise, the query may fail.	alb
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
ResourceRouteName	string	No	The name of the route. This parameter is available when you query MSE resources.	mse-default-traffic
ResourceDomain	string	No	The domain name of the resource. This parameter is available when you query FC or SAE resources.	fc-domain-test
ResourceFunction	string	No	The name of the function. This parameter is available when you query FC resources.	fc-test
OwnerUserId	string	No	The UID of the account to which the resource belongs.	11769793******
ResourceInstanceName	string	No	The name of the instance that is added to WAF.	test-name
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
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm4gh****wela

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	The response object.
TotalCount	integer	The total number of cloud services found.	121
RequestId	string	The request ID.	C327F81A-CCE2-5B21-817C-F93E29C5****
CloudResources	array<object>	A list of cloud services.
	object	Details about the cloud service.
ResourceRouteName	string	The name of the route. This parameter is returned for MSE instances.	test-route-name
ResourceRegionId	string	The region where the resource resides.	cn-hangzhou
ResourceFunction	string	The name of the function. This parameter is returned for FC instances.	test-resource-function
ResourceName `deprecated`	string	The name of the instance.	test-resource-name
ResourceInstance `deprecated`	string	The ID of the resource instance.	alb-ffff****
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 TCP clb7: CLB that uses HTTP or HTTPS nlb: NLB	alb
ResourceService	string	The name of the service. This parameter is returned for FC instances.	test-resource-service
ResourceDomain	string	The domain name of the resource. This parameter is returned for FC or SAE instances.	test-resource-domain
OwnerUserId	string	The UID of the account to which the resource belongs.	11769793******
HttpPortCount	integer	The number of HTTP ports that are added to WAF. Note This parameter is returned only for ECS and CLB instances.	1
HttpsPortCount	integer	The number of HTTPS ports that are added to WAF. Note This parameter is returned only for ECS and CLB instances.	1
ResourceInstanceIp	string	The IP address of the instance that is added to WAF.	1.1.1.1
ResourceInstanceId	string	The ID of the instance that is added to WAF.	lb-uf60ub45fr9b***
ResourceInstanceName	string	The name of the instance that is added to WAF.	test-name

Examples

Success response

JSON format

{
  "TotalCount": 121,
  "RequestId": "C327F81A-CCE2-5B21-817C-F93E29C5****",
  "CloudResources": [
    {
      "ResourceRouteName": "test-route-name",
      "ResourceRegionId": "cn-hangzhou",
      "ResourceFunction": "test-resource-function",
      "ResourceName": "test-resource-name",
      "ResourceInstance": "alb-ffff****",
      "ResourceProduct": "alb",
      "ResourceService": "test-resource-service",
      "ResourceDomain": "test-resource-domain",
      "OwnerUserId": "11769793******",
      "HttpPortCount": 1,
      "HttpsPortCount": 1,
      "ResourceInstanceIp": "1.1.1.1",
      "ResourceInstanceId": "lb-uf60ub45fr9b***",
      "ResourceInstanceName": "test-name"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.