AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

DescribeCloudResourceList - 查询云产品接入 WAF 配置列表

更新时间：
复制为 MD 格式
产品详情
我的收藏

查询云产品接入资源列表。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:DescribeCloudResourceList

list

*DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}

 无
  • yundun-waf:DescribeCloudResourceList

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值
InstanceId

string

是

WAF 实例的 ID。

说明

您可以调用 DescribeInstance ，查看当前 WAF 实例的 ID。

waf_elasticity-cn-0xldbqt****
ResourceManagerResourceGroupId

string

否

阿里云资源组 ID。

rg-acfm***q
OwnerUserId

string

否

资源归属用户 UID

1111111111
ResourceInstanceId

string

否

资源的实例 ID

i-8vbdlsd********81e22
Port

string

否

接入 WAF 的云产品端口。

80
ResourceProduct

string

否

资源所属云产品，取值：

  • alb：表示 ALB 产品。

  • mse：表示 MSE 产品。

  • fc：表示 FC 产品。

  • sae：表示 SAE 产品。

  • ecs：表示 ECS 产品。

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

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

  • apig：表示 APIG 产品。

  • nlb：表示 NLB 产品。

说明

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

ecs
CloudResourceId

string

否

已接入的资源 ID，云产品接入时由 WAF 自动生成。

说明

您可以通过 CreateCloudResource 接入资源后，查看响应中的资源 ID。

i-8vbdlsd********81e22-80-ecs
NextToken

string

否

下一页查询凭证（Token），如果有下一页，则该字段有返回值。

说明

该参数只要返回值，则说明还有下一页。您可以将返回的 NextToken 作为请求参数再次获得下一页的数据，直到无返回值，表示获取到了所有的数据。

AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
MaxResults

integer

否

分页查询时每页个数。取值范围为：1-100，默认值为 10。

10
RegionId

string

否

WAF 实例所属地域。取值：

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

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

cn-hangzhou
ResourceDomain

string

否

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

返回参数

名称

类型

描述

示例值

object

RequestId

string

本次请求的 ID。

F35F45B0-5D6B-4238-BE02-A62D****E840
NextToken

string

下一页查询凭证（Token），如果有下一页，则该字段有返回值。

说明

该参数只要返回值，则说明还有下一页。您可以将返回的 NextToken 作为请求参数再次获得下一页的数据，直到无返回值，表示获取到了所有的数据。

AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS
TotalCount

integer

返回结果的总数。

118
MaxResults

integer

分页查询时每页个数。

20
CloudResourceList

array<object>

云产品接入 WAF 的资源列表。

object

云产品接入 WAF 的资源。

Protocol

string

协议类型。取值：

  • http：表示 HTTP 协议。

  • https：表示 HTTPS 协议。

http
Port

integer

接入 WAF 的云产品端口。

80
ResourceRegionId

string

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

cn-hangzhou
ResourceInstanceId

string

已接入 WAF 的实例 ID。

i-8vbdlsd********81e22
ResourceProduct

string

资源所属云产品。取值：

  • alb：表示 ALB 产品。

  • mse：表示 MSE 产品。

  • fc：表示 FC 产品。

  • sae：表示 SAE 产品。

  • ecs：表示 ECS 产品。

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

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

  • nlb：表示 NLB 产品。

ecs
CloudResourceId

string

接入的资源 ID，由 WAF 自动生成。

i-8vbdlsd********81e22-80-ecs
ResourceManagerResourceGroupId

string

阿里云资源组 ID。

rg-aek2uo2****lbka
ResourceDomain

string

示例

正常返回示例

JSON格式

{
  "RequestId": "F35F45B0-5D6B-4238-BE02-A62D****E840",
  "NextToken": "AAAAAGBgV9tolsLfijC4wam2htS*****D/46H3X2wIS",
  "TotalCount": 118,
  "MaxResults": 20,
  "CloudResourceList": [
    {
      "Protocol": "http",
      "Port": 80,
      "ResourceRegionId": "cn-hangzhou",
      "ResourceInstanceId": "i-8vbdlsd********81e22",
      "ResourceProduct": "ecs",
      "CloudResourceId": "i-8vbdlsd********81e22-80-ecs",
      "ResourceManagerResourceGroupId": "rg-aek2uo2****lbka",
      "ResourceDomain": ""
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述
400 Waf.Instance.ValidFaild WAF instance check failed. Check whether the instance ID is correct. WAF实例检查失败，请确认实例ID是否正确
400 Waf.Pullin.CloudProductParamEmpty The resource Id of the cloud product accessing WAF is null or null values exist in the three input parameters of the cloud product name, port, and cloud product instance. 云产品接入WAF的资源Id为空 或 云产品名称、端口、云产品实例等3个入参中存在空值
400 Waf.Pullin.CloudResourceInvalid CloudResourceId parameter is illegal. CloudResourceId参数不合法

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

变更历史

更多信息，参考变更详情。

上一篇：ModifyCloudResourceCert - 修改云产品接入的证书下一篇：ModifyCloudResourceDefaultCert - 修改云产品的默认证书