DescribeProductInstances - Web Application Firewall - Alibaba Cloud Documentation Center

Queries the cloud service instances to be added to Web Application Firewall (WAF) in transparent proxy mode.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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-zxu****9d02
ResourceInstanceId	string	No	The ID of the instance.	lb-2zeugkfj81jvo****4tqm
ResourceName	string	No	The name of the instance.	exampleResourceName
ResourceRegionId	string	No	The region ID of the instance. Valid values: cn-chengdu: China (Chengdu). cn-beijing: China (Beijing). cn-zhangjiakou: China (Zhangjiakou). cn-hangzhou: China (Hangzhou). cn-shanghai: China (Shanghai). cn-shenzhen: China (Shenzhen). cn-qingdao: China (Qingdao). cn-hongkong: China (Hong Kong). ap-southeast-3: Malaysia (Kuala Lumpur). ap-southeast-5: Indonesia (Jakarta).	cn-hangzhou
ResourceProduct	string	No	The cloud service to which the instance belongs. Valid values: clb4: Layer 4 Classic Load Balancer (CLB). clb7: Layer 7 CLB. ecs: Elastic Compute Service (ECS).	clb7
PageNumber	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries per page. Default value: 10.	10
ResourceIp	string	No	The public IP address of the instance.	1.X.X.1
OwnerUserId	string	No	The ID of the Alibaba Cloud account to which the resource belongs.	1704********9107
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-aekz6ql****5uzi
RegionId	string	No	The region in which the WAF instance is deployed. Valid values: cn-hangzhou: Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	FDCBAE1E-2B3F-5C13-AD20-844B9473****
TotalCount	long	The total number of entries returned.	100
ProductInstances	object []	The information about the instances.
ResourceInstanceId	string	The ID of the instance.	i-2ze1tm4pvghp****cluv
ResourceName	string	The name of the instance.	ecs-test
ResourceRegionId	string	The region ID of the instance. Valid values: cn-chengdu: China (Chengdu). cn-beijing: China (Beijing). cn-zhangjiakou: China (Zhangjiakou). cn-hangzhou: China (Hangzhou). cn-shanghai: China (Shanghai). cn-shenzhen: China (Shenzhen). cn-qingdao: China (Qingdao). cn-hongkong: China (Hong Kong). ap-southeast-3: Malaysia (Kuala Lumpur). ap-southeast-5: Indonesia (Jakarta).	cn-beijing
ResourceProduct	string	The cloud service to which the instance belongs. Valid values: clb4: Layer 4 CLB. clb7: Layer 7 CLB. ecs: ECS.	clb4
ResourcePorts	object []	The information about the ports.
Port	integer	The port number.	443
Protocol	string	The protocol type. Valid values: http https	https
Certificates	object []	The information about the certificates.
CertificateName	string	The name of the certificate.	trafficxxxx.cn
CertificateId	string	The ID of the certificate.	10106183
ResourceIp	string	The public IP address of the instance.	1.X.X.1
OwnerUserId	string	The ID of the Alibaba Cloud account to which the resource belongs.	1704********9107

Examples

Sample success responses

JSONformat

{
  "RequestId": "FDCBAE1E-2B3F-5C13-AD20-844B9473****",
  "TotalCount": 100,
  "ProductInstances": [
    {
      "ResourceInstanceId": "i-2ze1tm4pvghp****cluv",
      "ResourceName": "ecs-test",
      "ResourceRegionId": "cn-beijing",
      "ResourceProduct": "clb4",
      "ResourcePorts": [
        {
          "Port": 443,
          "Protocol": "https",
          "Certificates": [
            {
              "CertificateName": "trafficxxxx.cn",
              "CertificateId": "10106183"
            }
          ]
        }
      ],
      "ResourceIp": "1.X.X.1",
      "OwnerUserId": "1704********9107"
    }
  ]
}

Error codes

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

Change history

Change time

Summary of changes

Operation

2024-04-02

The request parameters of the API has changed

see changesets

Change item	Change content
Input Parameters	The request parameters of the API has changed.
	Added Input Parameters: OwnerUserId