DescribeProductInstances - Web Application Firewall - Alibaba Cloud Documentation Center

Queries synchronized cloud service instances.

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

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The Web Application Firewall (WAF) instance ID. Note You can call the DescribeInstance operation to query the current WAF instance ID.	waf_v3prepaid_public_cn-zxu****9d02
ResourceInstanceId	string	No	The instance ID of the cloud service.	lb-2zeugkfj81jvo****4tqm
ResourceName `deprecated`	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 type of the cloud service. Valid values: clb4: Layer 4 CLB. clb7: Layer 7 CLB. ecs: Elastic Compute Service (ECS). nlb: Network Load Balancer (NLB).	clb7
PageNumber	integer	No	The page number of the returned page. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10.	10
ResourceIp `deprecated`	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 instance belongs.	1704********9107
ResourceInstanceIp	string	No	The IP address of the instance added to WAF.	1.X.X.1
ResourceInstanceName	string	No	The name of the instance added to WAF.	demoInstanceName
ResourceInstanceAccessStatus	string	No	The protection status of WAF. Valid values: all: All protected. any: Protected. part: Partially protected. non: Not protected.	all
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-aekz6ql****5uzi

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	FDCBAE1E-2B3F-5C13-AD20-844B9473****
TotalCount	integer	The total number of entries returned.	100
ProductInstances	array<object>	The information about the instances.
	object	The details of the cloud service.
ResourceInstanceId	string	The instance ID.	i-2ze1tm4pvghp****cluv
ResourceName `deprecated`	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 type of the cloud service. Valid values: clb4: Layer 4 CLB. clb7: Layer 7 CLB. ecs: ECS. nlb: NLB.	clb4
ResourcePorts	array<object>	The information about the ports.
	object	The details of the port.
Port	integer	The port.	443
Protocol	string	The protocol type. Valid values: http: HTTP protocol. https: HTTPS protocol.	https
Certificates	array<object>	The information about the certificates.
	object	The certificate.
CertificateName	string	The name of the certificate.	demoCertName
CertificateId	string	The certificate ID.	1234567
Domain	string	The domain name bound to the certificate.	www.test.com
AppliedType	string	The type of the HTTPS certificate. Valid values: default: Default certificate. extension: Extension certificate.	default
ResourceIp `deprecated`	string	The public IP address of the instance.	1.X.X.1
OwnerUserId	string	The user ID (UID) of the Alibaba Cloud account to which the instance belongs.	1704********9107
ResourceInstanceIp	string	The IP address of the instance.	1.X.X.1
ResourceInstanceName	string	The name of the instance.	demoInstanceName
AccessPorts	array	The list of ports added to WAF.
	integer	The port added to WAF.	80
ResourceInstanceAccessStatus	string	The protection status of WAF. Valid values: all: All protected. any: Protected. part: Partially protected. non: Not protected.	all
AccessPortAndProtocols	array<object>	The port and protocol information of the cloud service added to WAF.
	object	The port and protocol information of the cloud service added to WAF.
Port	integer	The port of the cloud service added to WAF.	443
Protocol	string	The protocol type. Valid values: http: HTTP protocol. https: HTTPS protocol.	http
CertificateIds	array	The certificates.
	string	The certificate ID.	5379758
AccessInstanceId	string	The ID of the instance added to WAF.	i-2ze1tm4pvghp****cluv
ResourceInstanceEdition	string	The edition of the instance.	ecs.e-c1m1.large

Examples

Success response

JSON format

{
  "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": "demoCertName",
              "CertificateId": "1234567",
              "Domain": "www.test.com",
              "AppliedType": "default"
            }
          ]
        }
      ],
      "ResourceIp": "1.X.X.1",
      "OwnerUserId": "1704********9107",
      "ResourceInstanceIp": "1.X.X.1",
      "ResourceInstanceName": "demoInstanceName",
      "AccessPorts": [
        80
      ],
      "ResourceInstanceAccessStatus": "all",
      "AccessPortAndProtocols": [
        {
          "Port": 443,
          "Protocol": "http",
          "CertificateIds": [
            "5379758"
          ]
        }
      ],
      "AccessInstanceId": "i-2ze1tm4pvghp****cluv\n",
      "ResourceInstanceEdition": "ecs.e-c1m1.large"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.