DescribeProductInstances - 查询已同步的云产品资产列表_Web应用防火墙(WAF)-阿里云帮助中心

查询已同步的云产品资产列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-waf:DescribeProductInstances	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例 ID。说明您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。	waf_v3prepaid_public_cn-zxu****9d02
ResourceInstanceId	string	否	云产品的实例 ID。	lb-2zeugkfj81jvo****4tqm
ResourceName`deprecated`	string	否	云产品的实例名称。	exampleResourceName
ResourceRegionId	string	否	云产品归属地域 ID。取值： cn-chengdu：表示西南 1（成都）。 cn-beijing：表示华北 2（北京）。 cn-zhangjiakou：表示华北 3（张家口）。 cn-hangzhou：表示华东 1（杭州）。 cn-shanghai：表示华东 2（上海）。 cn-shenzhen：表示华南 1（深圳）。 cn-qingdao：表示华北 1（青岛）。 cn-hongkong：表示中国（香港）。 ap-southeast-3：表示马来西亚（吉隆坡）。 ap-southeast-5：表示印度尼西亚（雅加达）。	cn-hangzhou
ResourceProduct	string	否	云产品类型。取值： clb4：表示四层 CLB 产品。 clb7：表示七层 CLB 产品。 ecs：表示 ECS 产品。	clb7
PageNumber	long	否	当前页码。默认值：1。	1
PageSize	long	否	分页查询时，每页的行数。默认值为 10。	10
ResourceIp`deprecated`	string	否	云产品的公网 IP。	1.X.X.1
OwnerUserId	string	否	资源归属用户 UID。	1704********9107
ResourceInstanceIp	string	否	已接入 WAF 的实例 IP。	1.X.X.1
ResourceInstanceName	string	否	已接入 WAF 的实例名称。	demoInstanceName
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-aekz6ql****5uzi

返回参数

名称	类型	描述	示例值
	object
RequestId	string	本次请求的 ID。	FDCBAE1E-2B3F-5C13-AD20-844B9473****
TotalCount	long	返回结果的总数。	100
ProductInstances	array<object>	云产品信息列表。
CloudResource	object	云产品信息。
ResourceInstanceId	string	云产品实例 ID。	i-2ze1tm4pvghp****cluv
ResourceName`deprecated`	string	云产品实例名称。	ecs-test
ResourceRegionId	string	云产品归属地域 ID，取值： cn-chengdu：表示西南 1（成都）。 cn-beijing：表示华北 2（北京）。 cn-zhangjiakou：表示华北 3（张家口）。 cn-hangzhou：表示华东 1（杭州）。 cn-shanghai：表示华东 2（上海）。 cn-shenzhen：表示华南 1（深圳）。 cn-qingdao：表示华北 1（青岛）。 cn-hongkong：表示中国（香港）。 ap-southeast-3：表示马来西亚（吉隆坡）。 ap-southeast-5：表示印度尼西亚（雅加达）。	cn-beijing
ResourceProduct	string	云产品类型。取值： clb4：表示四层 CLB 产品。 clb7：表示七层 CLB 产品。 ecs：表示 ECS 产品。	clb4
ResourcePorts	array<object>	端口信息列表。
Port	object	端口信息。
Port	integer	端口。	443
Protocol	string	网络协议类型。取值： http：表示 HTTP 协议。 https：表示 HTTPS 协议。	https
Certificates	array<object>	证书信息列表。
Certificate	object	证书信息。
CertificateName	string	SSL 证书名称。	demoCertName
CertificateId	string	证书 ID。	1234567
ResourceIp`deprecated`	string	云产品的公网 IP。	1.X.X.1
OwnerUserId	string	资源归属用户 UID。	1704********9107
ResourceInstanceIp	string	已接入 WAF 的实例 IP。	1.X.X.1
ResourceInstanceName	string	已接入 WAF 的实例名称。	demoInstanceName

示例

正常返回示例

JSON格式

{
  "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"
            }
          ]
        }
      ],
      "ResourceIp": "1.X.X.1",
      "OwnerUserId": "1704********9107",
      "ResourceInstanceIp": "1.X.X.1",
      "ResourceInstanceName": "demoInstanceName"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-07-09	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-04-02	OpenAPI 入参发生变更	查看变更详情