All Products
Search

This Product

    Web Application Firewall:DescribeCloudResources

    Document Center

    Web Application Firewall:DescribeCloudResources

    Last Updated:Apr 23, 2024

    Queries cloud service resources that are added to Web Application Firewall (WAF).

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    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
    ResourceInstanceIdstringNo

    The ID of the resource.

    		alb-43glijk0fr****gths
    ResourceNamestringNo

    The name of the resource.

    		alb-name
    ResourceRegionIdstringNo

    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
    ResourceProductstringNo

    The cloud service to which the resource belongs. Valid values:

    • alb: Application Load Balancer (ALB).
    • mse: Microservices Engine (MSE).
    • fc: Function Compute.
    • sae: Serverless App Engine (SAE).
    Note Different cloud services are available in different regions. The specified cloud service must be available in the specified region.
    		alb
    PageNumberlongNo

    The page number. Default value: 1.

    		1
    PageSizelongNo

    The number of entries per page. Default value: 10.

    		10
    ResourceRouteNamestringNo

    The route name. You can use this parameter if you set ResourceProduct to mse.

    		mse-default-traffic
    ResourceDomainstringNo

    The domain name. You can use this parameter if you set ResourceProduct to fc or sae.

    		fc-domain-test
    ResourceFunctionstringNo

    The function name. You can use this parameter if you set ResourceProduct to fc.

    		fc-test
    OwnerUserIdstringNo

    The ID of the Alibaba Cloud account to which the resource belongs.

    		11769793******
    ResourceManagerResourceGroupIdstringNo

    The ID of the Alibaba Cloud resource group.

    		rg-acfm4gh****wela
    RegionIdstringNo

    The region in which the WAF instance is deployed. Valid values:

    • cn-hangzhou: Chinese mainland.
    • ap-southeast-1: outside the Chinese mainland.
    		cn-hangzhou
    Region IDRegion nameSupported services
    cn-hangzhouChina (Hangzhou)SAE,ALB,FC,MSE
    cn-shanghaiChina (Shanghai)SAE,ALB,FC,MSE
    cn-shenzhenChina (Shenzhen)SAE,ALB,FC,MSE
    cn-beijingChina (Beijing)SAE,ALB,FC,MSE
    cn-zhangjiakouChina (Zhangjiakou)SAE,ALB,FC,MSE
    cn-chengduChina (Chengdu)ALB
    cn-qingdaoChina (Qingdao)ALB
    cn-guangzhouChina (Guangzhou)ALB
    cn-wulanchabuChina (Ulanqab)ALB
    cn-hongkongChina (Hong Kong)ALB,MSE
    cn-fuzhouChina (Fuzhou - Local Region)ALB
    ap-southeast-6Philippines (Manila)ALB
    ap-southeast-5Indonesia (Jakarta)ALB
    ap-northeast-1Japan (Tokyo)ALB
    ap-southeast-3Malaysia (Kuala Lumpur)ALB,MSE
    ap-southeast-2Australia (Sydney)ALB
    ap-southeast-1SingaporeALB,MSE
    ap-south-1India (Mumbai)ALB
    eu-central-1Germany (Frankfurt)ALB
    us-west-1US (Silicon Valley)ALB
    us-east-1US (Virginia)ALB

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    TotalCountlong

    The total number of cloud service resources returned.

    		121
    RequestIdstring

    The request ID.

    		C327F81A-CCE2-5B21-817C-F93E29C5****
    CloudResourcesobject []

    The cloud service resources that are added to WAF.

    ResourceRouteNamestring

    The route name. This parameter has a value only if the value of ResourceProduct is mse.

    		test-route-name
    ResourceRegionIdstring

    The region ID of the resource.

    		cn-hangzhou
    ResourceFunctionstring

    The function name. This parameter has a value only if the value of ResourceProduct is fc.

    		test-resource-function
    ResourceNamestring

    The name of the resource.

    		test-resource-name
    ResourceInstancestring

    The ID of the resource.

    		alb-ffff****
    ResourceProductstring

    The cloud service to which the resource belongs. Valid values:

    • alb: ALB.
    • mse: MSE.
    • fc: Function Compute.
    • sae: SAE.
    		alb
    ResourceServicestring

    The service name. This parameter has a value only if the value of ResourceProduct is fc.

    		test-resource-service
    ResourceDomainstring

    The domain name. This parameter has a value only if the value of ResourceProduct is fc or sae.

    		test-resource-domain
    OwnerUserIdstring

    The ID of the Alibaba Cloud account to which the resource belongs.

    		11769793******

    Examples

    Sample success responses

    JSONformat

    {
  "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******"
    }
  ]
}

    Error codes

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