全部产品
Search

搜索本产品

    Web 应用防火墙：DescribeCloudResources - 查询云产品接入WAF的实例列表

    文档中心

    Web 应用防火墙：DescribeCloudResources - 查询云产品接入WAF的实例列表

    更新时间：Dec 12, 2024

    查询接入到WAF的云产品列表情况。

    调试

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

    授权信息

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

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

    请求参数

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

    WAF 实例 ID。

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

    资源的实例 ID。

    		alb-43glijk0fr****gths
    ResourceNamedeprecatedstring否

    资源的实例名称。

    		alb-name
    ResourceRegionIdstring否

    资源归属地域 ID，取值请查看返回参数补充说明。

    说明 每个产品支持的地域不同，产品筛选字段有值时，需要参考地域支持的产品，否则可能导致筛选失败。
    		cn-beijing
    ResourceProductstring否

    资源所属云产品，默认返回 ALB、MSE、FC 和 SAE 产品的实例，取值：

    • alb：表示 ALB 产品。

    • mse：表示 MSE 产品。

    • fc：表示 FC 产品。

    • sae：表示 SAE 产品。

    • ecs：表示 ECS 产品。

    • clb4：表示 CLB(TCP)产品。

    • clb7：表示 CLB(HTTP/HTTPS)产品。

    • nlb：表示 NLB 产品。

    说明 每个产品支持的地域不同，产品筛选字段有值时，需要参考地域支持的产品，否则可能导致筛选失败。
    		alb
    PageNumberlong否

    分页查询请求时返回的页码。默认值为 1。

    		1
    PageSizelong否

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

    		10
    ResourceRouteNamestring否

    资源的路由名称，当 MSE 接入可以使用该字段查询。

    		mse-default-traffic
    ResourceDomainstring否

    资源的域名名称，当 FC，SAE 接入可以使用该字段查询。

    		fc-domain-test
    ResourceFunctionstring否

    资源的函数名称，当 FC 接入可以使用该字段查询。

    		fc-test
    OwnerUserIdstring否

    资源归属用户 UID。

    		11769793******
    ResourceInstanceNamestring否

    已接入 WAF 的实例名称。

    		test-name
    RegionIdstring否

    WAF 实例所属地域。取值：

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

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

    		cn-hangzhou
    ResourceManagerResourceGroupIdstring否

    阿里云资源组 ID。

    		rg-acfm4gh****wela
    地域 ID地域名称支持的产品
    cn-hangzhou华东 1（杭州）SAE,ALB,FC,MSE,ECS,CLB
    cn-shanghai华东 2（上海）SAE,ALB,FC,MSE,ECS,CLB
    cn-shenzhen华南 1（深圳）SAE,ALB,FC,MSE,ECS,CLB
    cn-beijing华北 2（北京）SAE,ALB,FC,MSE,ECS,CLB
    cn-zhangjiakou华北 3（张家口）SAE,ALB,FC,MSE,ECS,CLB
    cn-chengdu西南 1（成都）ALB,ECS,CLB
    cn-qingdao华北 1（青岛）ALB,ECS,CLB
    cn-guangzhou华南 3（广州）ALB
    cn-wulanchabu华北 6（乌兰察布）ALB
    cn-hongkong中国香港ALB,MSE,ECS,CLB
    cn-fuzhou华东 6（福州-本地地域）ALB
    ap-southeast-6菲律宾（马尼拉）ALB
    ap-southeast-5印度尼西亚（雅加达）ALB,ECS,CLB
    ap-northeast-1日本（东京）ALB
    ap-southeast-3马来西亚（吉隆坡）ALB,MSE,ECS,CLB
    ap-southeast-1新加坡ALB,MSE
    eu-central-1德国（法兰克福）ALB
    us-west-1美国（硅谷）ALB
    us-east-1美国（弗吉尼亚）ALB

    返回参数

    名称类型描述示例值
    object

    云产品接入列表。

    TotalCountlong

    查询到的云产品接入总数量。

    		121
    RequestIdstring

    请求 ID。

    		C327F81A-CCE2-5B21-817C-F93E29C5****
    CloudResourcesarray<object>

    云产品接入列表。

    CloudResourceobject

    云产品接入信息。

    ResourceRouteNamestring

    资源的路由名称，当 mse 接入时，该字段有值。

    		test-route-name
    ResourceRegionIdstring

    资源归属地。

    		cn-hangzhou
    ResourceFunctionstring

    资源的函数名称，当 FC 接入时，该字段有值。

    		test-resource-function
    ResourceNamedeprecatedstring

    实例名称

    		test-resource-name
    ResourceInstancedeprecatedstring

    资源实例 ID。

    		alb-ffff****
    ResourceProductstring

    资源所属云产品。取值：

    • alb：表示 ALB 产品。

    • mse：表示 MSE 产品。

    • fc：表示 FC 产品。

    • sae：表示 SAE 产品。

    • ecs：表示 ECS 产品。

    • clb4：表示 CLB(TCP)产品。

    • clb7：表示 CLB(HTTP/HTTPS)产品。

    		alb
    ResourceServicestring

    资源的服务名称，当 FC 接入时，该字段有值。

    		test-resource-service
    ResourceDomainstring

    资源的域名名称，当 FC，SAE 接入时，该字段有值。

    		test-resource-domain
    OwnerUserIdstring

    资源归属用户 UID。

    		11769793******
    HttpPortCountinteger

    已接入 WAF 的 HTTP 协议端口数。

    说明 只有 ECS 和 CLB 实例才返回。
    		1
    HttpsPortCountinteger

    已接入 WAF 的 HTTPS 协议端口数。

    说明 只有 ECS 和 CLB 实例才返回。
    		1
    ResourceInstanceIpstring

    已接入 WAF 的实例 IP。

    		1.1.1.1
    ResourceInstanceIdstring

    已接入 WAF 的实例 ID。

    		lb-uf60ub45fr9b***
    ResourceInstanceNamestring

    已接入 WAF 的实例名称。

    		test-name

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 121,
  "RequestId": "C327F81A-CCE2-5B21-817C-F93E29C5****",
  "CloudResources": [
    {
      "ResourceRouteName": "test-route-name",
      "ResourceRegionId": "cn-hangzhou",
      "ResourceFunction": "test-resource-function",
      "ResourceName": "test-resource-name",
      "ResourceInstance": "alb-ffff****",
      "ResourceProduct": "alb",
      "ResourceService": "test-resource-service",
      "ResourceDomain": "test-resource-domain",
      "OwnerUserId": "11769793******",
      "HttpPortCount": 1,
      "HttpsPortCount": 1,
      "ResourceInstanceIp": "1.1.1.1",
      "ResourceInstanceId": "lb-uf60ub45fr9b***",
      "ResourceInstanceName": "test-name"
    }
  ]
}

    错误码

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

    变更历史

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