All Products
Search
Document Center

Web Application Firewall:DescribeProductInstances

Last Updated:Nov 15, 2024

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-waf:DescribeProductInstancesget
*All Resources
*
    none
none

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-zxu****9d02
ResourceInstanceIdstringNo

The ID of the instance.

lb-2zeugkfj81jvo****4tqm
ResourceNamedeprecatedstringNo

The name of the instance.

exampleResourceName
ResourceRegionIdstringNo

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
ResourceProductstringNo

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
PageNumberlongNo

The page number. Default value: 1.

1
PageSizelongNo

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

10
ResourceIpdeprecatedstringNo

The public IP address of the instance.

1.X.X.1
OwnerUserIdstringNo

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

1704********9107
ResourceInstanceIpstringNo

The IP address of the instance that is added to WAF.

1.X.X.1
ResourceInstanceNamestringNo

The name of the instance that is added to WAF.

demoInstanceName
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
ResourceManagerResourceGroupIdstringNo

The ID of the Alibaba Cloud resource group.

rg-aekz6ql****5uzi

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

FDCBAE1E-2B3F-5C13-AD20-844B9473****
TotalCountlong

The total number of entries returned.

100
ProductInstancesarray<object>

The information about the instances.

CloudResourceobject

The information about the instance.

ResourceInstanceIdstring

The ID of the instance.

i-2ze1tm4pvghp****cluv
ResourceNamedeprecatedstring

The name of the instance.

ecs-test
ResourceRegionIdstring

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
ResourceProductstring

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

  • clb4: Layer 4 CLB.
  • clb7: Layer 7 CLB.
  • ecs: ECS.
clb4
ResourcePortsarray<object>

The information about the ports.

Portobject
Portinteger

The port number.

443
Protocolstring

The protocol type. Valid values:

  • http
  • https
https
Certificatesarray<object>

The information about the certificates.

Certificateobject
CertificateNamestring

The name of the certificate.

trafficxxxx.cn
CertificateIdstring

The ID of the certificate.

10106183
ResourceIpdeprecatedstring

The public IP address of the instance.

1.X.X.1
OwnerUserIdstring

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

1704********9107
ResourceInstanceIpstring

The IP address of the instance that is added to WAF.

1.X.X.1
ResourceInstanceNamestring

The name of the instance that is added to WAF.

demoInstanceName

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",
      "ResourceInstanceIp": "1.X.X.1",
      "ResourceInstanceName": "demoInstanceName"
    }
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-07-09The request parameters of the API has changed. The response structure of the API has changedView Change Details
2024-04-02The request parameters of the API has changedView Change Details