Queries cloud service resources that are added to Web Application Firewall (WAF).
Debugging
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:DescribeCloudResources | list | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The ID of the WAF instance. Note
You can 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. | alb-43glijk0fr****gths |
ResourceNamedeprecated | string | No | The name of the resource. | alb-name |
ResourceRegionId | string | No | The region ID of the resource. For information about region IDs, see the following table. Note
Different cloud services are available in different regions. The specified cloud service must be available in the specified region.
| cn-beijing |
ResourceProduct | string | No | The cloud service to which the resource belongs. If you do not specify this parameter, the system automatically returns the Application Load Balancer (ALB), Microservices Engine (MSE), Function Compute, and Serverless App Engine (SAE) resources that are added to WAF. Valid values:
Note
Different cloud services are available in different regions. The specified cloud service must be available in the specified region.
| alb |
PageNumber | long | No | The page number. Default value: 1. | 1 |
PageSize | long | No | The number of entries per page. Default value: 10. | 10 |
ResourceRouteName | string | No | The route name. You can use this parameter if you set ResourceProduct to mse. | mse-default-traffic |
ResourceDomain | string | No | The domain name. You can use this parameter if you set ResourceProduct to fc or sae. | fc-domain-test |
ResourceFunction | string | No | The function name. You can use this parameter if you set ResourceProduct to fc. | fc-test |
OwnerUserId | string | No | The ID of the Alibaba Cloud 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 in which the WAF instance is deployed. Valid values:
| cn-hangzhou |
ResourceManagerResourceGroupId | string | No | The ID of the Alibaba Cloud resource group. | rg-acfm4gh****wela |
Region ID | Region name | Supported service |
---|---|---|
cn-hangzhou | China (Hangzhou) | SAE,ALB,FC,MSE,ECS,CLB |
cn-shanghai | China (Shanghai) | SAE,ALB,FC,MSE,ECS,CLB |
cn-shenzhen | China (Shenzhen) | SAE,ALB,FC,MSE,ECS,CLB |
cn-beijing | China (Beijing) | SAE,ALB,FC,MSE,ECS,CLB |
cn-zhangjiakou | China (Zhangjiakou) | SAE,ALB,FC,MSE,ECS,CLB |
cn-chengdu | China (Chengdu) | ALB,ECS,CLB |
cn-qingdao | China (Qingdao) | ALB,ECS,CLB |
cn-guangzhou | China (Guangzhou) | ALB |
cn-wulanchabu | China (Ulanqab) | ALB |
cn-hongkong | China (Hong Kong) | ALB,MSE,ECS,CLB |
cn-fuzhou | China (Fuzhou - Local Region) | ALB |
ap-southeast-6 | Philippines (Manila) | ALB |
ap-southeast-5 | Indonesia (Jakarta) | ALB,ECS,CLB |
ap-northeast-1 | Japan (Tokyo) | ALB |
ap-southeast-3 | Malaysia (Kuala Lumpur) | ALB,MSE,ECS,CLB |
ap-southeast-1 | Singapore | ALB,MSE |
ap-south-1 | India (Mumbai) (Closing Down) | ALB |
eu-central-1 | Germany (Frankfurt) | ALB |
us-west-1 | US (Silicon Valley) | ALB |
us-east-1 | US (Virginia) | ALB |
Response parameters
Examples
Sample success responses
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
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-07-09 | API Description Update. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |