全部产品
Search
文档中心

Web 应用防火墙:DescribeProductInstances - 查询已同步的云产品资产列表

更新时间:Nov 15, 2024

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
InstanceIdstring

WAF 实例 ID。

说明 您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。
waf_v3prepaid_public_cn-zxu****9d02
ResourceInstanceIdstring

云产品的实例 ID。

lb-2zeugkfj81jvo****4tqm
ResourceNamedeprecatedstring

云产品的实例名称。

exampleResourceName
ResourceRegionIdstring

云产品归属地域 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
ResourceProductstring

云产品类型。取值:

  • clb4:表示四层 CLB 产品。

  • clb7:表示七层 CLB 产品。

  • ecs:表示 ECS 产品。

clb7
PageNumberlong

当前页码。默认值:1

1
PageSizelong

分页查询时,每页的行数。默认值为 10

10
ResourceIpdeprecatedstring

云产品的公网 IP。

1.X.X.1
OwnerUserIdstring

资源归属用户 UID。

1704********9107
ResourceInstanceIpstring

已接入 WAF 的实例 IP。

1.X.X.1
ResourceInstanceNamestring

已接入 WAF 的实例名称。

demoInstanceName
RegionIdstring

WAF 实例所属地域。取值:

  • cn-hangzhou:表示中国内地。

  • ap-southeast-1:表示非中国内地。

cn-hangzhou
ResourceManagerResourceGroupIdstring

阿里云资源组 ID。

rg-aekz6ql****5uzi

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求的 ID。

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

返回结果的总数。

100
ProductInstancesarray<object>

云产品信息列表。

CloudResourceobject

云产品信息。

ResourceInstanceIdstring

云产品实例 ID。

i-2ze1tm4pvghp****cluv
ResourceNamedeprecatedstring

云产品实例名称。

ecs-test
ResourceRegionIdstring

云产品归属地域 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
ResourceProductstring

云产品类型。取值:

  • clb4:表示四层 CLB 产品。

  • clb7:表示七层 CLB 产品。

  • ecs:表示 ECS 产品。

clb4
ResourcePortsarray<object>

端口信息列表。

Portobject

端口信息。

Portinteger

端口。

443
Protocolstring

网络协议类型。取值:

  • http:表示 HTTP 协议。
  • https:表示 HTTPS 协议。
https
Certificatesarray<object>

证书信息列表。

Certificateobject

证书信息。

CertificateNamestring

SSL 证书名称。

demoCertName
CertificateIdstring

证书 ID。

1234567
ResourceIpdeprecatedstring

云产品的公网 IP。

1.X.X.1
OwnerUserIdstring

资源归属用户 UID。

1704********9107
ResourceInstanceIpstring

已接入 WAF 的实例 IP。

1.X.X.1
ResourceInstanceNamestring

已接入 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-09OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-04-02OpenAPI 入参发生变更查看变更详情