Queries the list of resources connected to WAF in cloud native mode.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-waf:DescribeCloudResourceList |
list |
*DefenseResource
|
None |
|
Request syntax
POST HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The ID of the WAF instance. Note
You can call DescribeInstance to query the ID of the current 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 ownership user. |
1111111111 |
| ResourceInstanceId |
string |
No |
The instance ID of the resource. |
i-8vbdlsd********81e22 |
| Port |
string |
No |
The port of the cloud service connected to WAF. |
80 |
| ResourceProduct |
string |
No |
The cloud service to which the resource belongs. Valid values:
Note
Different products are supported in different regions. If you specify a value for this parameter, make sure that the product is supported in the specified region. Otherwise, the query may fail. |
ecs |
| CloudResourceId |
string |
No |
The ID of the connected resource, which is automatically generated by WAF in cloud native mode. Note
You can call CreateCloudResource to connect a resource and then view the resource ID in the response. |
i-8vbdlsd********81e22-80-ecs |
| NextToken |
string |
No |
The pagination token for the next page. If a value is returned for this parameter, the next page exists. Note
If this parameter has a return value, the next page exists. You can use the returned NextToken value as a request parameter to obtain the next page of data. 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 per page in a paged query. Valid values: 1 to 100. Default value: 10. |
10 |
| RegionId |
string |
No |
The region where the WAF instance resides. Valid values:
|
cn-hangzhou |
| ResourceDomain |
string |
No |
The domain name connected to WAF. Note
This parameter is supported only when the cloud service type is ddos. |
www.c**sw.net |
| Region ID | Region | 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 | Hong Kong (China) | ALB,MSE,ECS,CLB,NLB |
| cn-fuzhou | China (Fuzhou - Local Region - Discontinuing) | 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 pagination token for the next page. If a value is returned for this parameter, the next page exists. Note
If this parameter has a return value, the next page exists. You can use the returned NextToken value as a request parameter to obtain the next page of data. 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 per page in a paged query. |
20 |
| CloudResourceList |
array<object> |
The list of resources connected to WAF in cloud native mode. |
|
|
object |
The resource connected to WAF in cloud native mode. |
||
| Protocol |
string |
The protocol type. Valid values:
|
http |
| Port |
integer |
The port of the cloud service connected to WAF. |
80 |
| ResourceRegionId |
string |
The resource ownership region ID. For valid values, see the supplementary description of response parameters. |
cn-hangzhou |
| ResourceInstanceId |
string |
The instance ID of the resource connected to WAF. |
i-8vbdlsd********81e22 |
| ResourceProduct |
string |
The cloud service to which the resource belongs. Valid values:
|
ecs |
| CloudResourceId |
string |
The ID of the connected resource, which is automatically generated by WAF. |
i-8vbdlsd********81e22-80-ecs |
| ResourceManagerResourceGroupId |
string |
The ID of the Alibaba Cloud resource group. |
rg-aek2uo2****lbka |
| ResourceDomain |
string |
The domain name connected to WAF. |
www.c**sw.net |
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",
"ResourceDomain": "www.c**sw.net"
}
]
}
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.