DescribeHybridCloudResources - 查询混合云CNAME接入列表 - Web 应用防火墙

查询混合云域名列表。

调试

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

授权信息

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

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

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例的 ID。说明您可以调用 DescribeInstance ，查看当前 WAF 实例的 ID。	waf_v3prepaid_public_cn-***********
Domain	string	否	要查询的域名名称。	www.aliyundoc.com
Backend	string	否	域名对应的源站服务器 IP 或服务器回源域名。	1.1.XX.XX
PageNumber	long	否	分页查询时，返回第几页数据。默认值为 1，表示返回第 1 页数据。	1
PageSize	long	否	分页查询时，每页包含多少条结果。默认值为 10，表示每页包含 10 条结果。	10
CnameEnabled	boolean	否	是否开启公共云容灾。取值： true：表示开启公共云容灾。 false：表示不开启公共云容灾。	true
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfmvtc5z52****

返回参数

名称	类型	描述	示例值
	object
Domains	array<object>	本次获取的域名列表。
	object	域名接入详情。
Status	integer	域名状态。取值： 1：表示域名处于正常状态。 2：表示域名创建中。 3：表示域名修改中。 4：表示域名释放中。 5：表示域名停止转发。	1
ResourceManagerResourceGroupId	string	阿里云资源组 ID。	rg-acfmvtc5z52****
Uid	string	用户 ID。	130715431409****
Listen	object	配置监听信息。
HttpsPorts	array	HTTPS 端口列表。
	long	HTTPS 协议的端口。	443
ProtectionResource	string	要使用的防护资源类型。取值： share：表示使用共享集群。 gslb：表示使用共享集群智能负载均衡。	share
CustomCiphers	array	要添加的具体自定义加密套件。说明仅 CipherSuite 取值为 99 时，返回该参数。
	string	自定义加密套件。	ECDHE-ECDSA-AES128-GCM-SHA256
TLSVersion	string	TLS 的版本。取值： tlsv1 tlsv1.1 tlsv1.2	tlsv1.2
Http2Enabled	boolean	是否开启 HTTP2。取值： true：表示开启 HTTP2。 false：表示不开启 HTTP2。	false
CertId	string	证书 ID	72***76-cn-hangzhou
CipherSuite	integer	加密套件类型。取值： 1：表示添加全部加密套件。 2：表示添加强加密套件。 99：表示添加自定义加密套件。	1
EnableTLSv3	boolean	是否支持 TLS1.3 版本。取值： true：表示支持 TLS1.3 版本。 false：表示不支持 TLS1.3 版本。	true
IPv6Enabled	boolean	开启 IPv6 是否开启 IPv6。取值： true：表示开启 IPv6。 false：表示不开启 IPv6。	false
FocusHttps	boolean	是否开启 HTTPS 的强制跳转。取值： true：表示开启 HTTPS 的强制跳转。 false：表示不开启 HTTPS 的强制跳转。	false
XffHeaders	array	用于获取客户端 IP 的自定义字段列表，使用["header1","header2",……]格式表示。说明仅在 XffHeaderMode 取值为 2（表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP）时，返回该参数。
	string	用于获取客户端 IP 的自定义字段列表。	Client-ip
XffHeaderMode	integer	WAF 获取客户端真实 IP 的方式。取值： 0：表示客户端访问流量到 WAF 前没有经过其他七层代理转发。 1：表示 WAF 读取请求头中 X-Forwarded-For（XFF）字段的第一个值作为客户端 IP。 2：表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP。	0
ExclusiveIp	boolean	是否支持独享 IP。取值： true：表示支持。 false：表示不支持。	true
HttpPorts	array	HTTP 协议的监听端口列表。
	long	HTTP 协议的监听端口。	80
Id	long	接入 ID。	12345
Redirect	object	配置转发信息。
ConnectTimeout	long	连接超时时长。单位：秒。取值范围：5~120。	120
Keepalive	boolean	是否保持长连接。取值： true：表示保持长连接。 false：表示不保持长连接。	true
SniEnabled	boolean	是否开启回源 SNI。取值： true：表示开启回源 SNI。 false：表示不开启回源 SNI。	true
CnameEnabled	boolean	是否开启公共云容灾。取值： true：表示开启公共云容灾。 false：表示不开启公共云容灾。	true
KeepaliveTimeout	long	空闲长连接超时时间，取值范围：1~60，默认 15，单位：秒。说明复用的长连接空闲多久后释放。	15
ReadTimeout	long	读超时时长，单位：秒。取值范围：5~1800。	200
Backends	array	域名对应的源站服务器 IP 或服务器回源域名。
	string	域名对应的源站服务器 IP 或服务器回源域名。	1.1.XX.XX
SniHost	string	SNI 扩展字段的自定义值。取值为空表示未自定义 SNI 值，默认使用请求头中 Host 字段的值作为 SNI 扩展字段的值。说明仅在 SniEnabled 取值为 true（表示开启 SNI 回源）时，返回该参数。	www.aliyundoc.com
FocusHttpBackend	boolean	是否开启强制 HTTP 回源。取值： true：表示开启强制 HTTP 回源。 false：表示不开启强制 HTTP 回源。	true
WriteTimeout	long	写超时时长，单位：秒。取值范围：5~1800。	200
RoutingRules	string	混合云转发规则。使用 JSON 数组转化的字符串格式表示。JSON 数组中的每个元素是一个结构体，包含以下字段： rs：Array 类型 \| 表示回源 IP 地址或者回源 CNAME 列表 location：String 类型 \| 表示防护节点名称 locationId：Long 类型 \| 表示防护节点 ID	[ { "rs": [ "1.1.XX.XX" ], "locationId": 535, "location": "test1111" } ]
Retry	boolean	WAF 回源失败时，是否重试。取值： true：表示重试。 false：表示不重试。	true
RequestHeaders	array<object>	域名的流量标记字段和值，用于标记经过 WAF 处理的流量。
	object	域名的流量标记字段和值，用于标记经过 WAF 处理的流量。
Value	string	指定的自定义请求头部字段设定的值。	bbb
Key	string	指定的自定义请求头部字段。	aaa
KeepaliveRequests	long	复用长连接的请求个数。取值范围：60~1000，单位：个。说明开启长连接后，复用多少个长连接。	1000
Loadbalance	string	回源时采用的负载均衡算法。取值： iphash：表示 IP Hash 算法。 roundRobin：表示轮询算法。 leastTime：表示 Least Time 算法。	iphash
Domain	string	域名	www.aliyundoc.com
Cname	string	WAF 为域名分配的 CNAME 地址。说明仅在 CnameEnabled 取值为 true（表示开启公共云容灾）时，返回该参数。	50fqmu1ci7g0xtiyxnrhgx6qdhmn****.yundunwaf5.com
TotalCount	long	返回结果的总数。	24
RequestId	string	本次请求的 ID。	98D2AA9A-5959-5CCD-83E3-B6606232A2BE

示例

正常返回示例

JSON格式

{
  "Domains": [
    {
      "Status": 1,
      "ResourceManagerResourceGroupId": "rg-acfmvtc5z52****",
      "Uid": "130715431409****",
      "Listen": {
        "HttpsPorts": [
          443
        ],
        "ProtectionResource": "share",
        "CustomCiphers": [
          "ECDHE-ECDSA-AES128-GCM-SHA256"
        ],
        "TLSVersion": "tlsv1.2",
        "Http2Enabled": false,
        "CertId": "72***76-cn-hangzhou",
        "CipherSuite": 1,
        "EnableTLSv3": true,
        "IPv6Enabled": false,
        "FocusHttps": false,
        "XffHeaders": [
          "Client-ip"
        ],
        "XffHeaderMode": 0,
        "ExclusiveIp": true,
        "HttpPorts": [
          80
        ]
      },
      "Id": 12345,
      "Redirect": {
        "ConnectTimeout": 120,
        "Keepalive": true,
        "SniEnabled": true,
        "CnameEnabled": true,
        "KeepaliveTimeout": 15,
        "ReadTimeout": 200,
        "Backends": [
          "1.1.XX.XX"
        ],
        "SniHost": "www.aliyundoc.com",
        "FocusHttpBackend": true,
        "WriteTimeout": 200,
        "RoutingRules": "[\n      {\n            \"rs\": [\n                  \"1.1.XX.XX\"\n            ],\n            \"locationId\": 535,\n            \"location\": \"test1111\"\n      }\n]",
        "Retry": true,
        "RequestHeaders": [
          {
            "Value": "bbb",
            "Key": "aaa"
          }
        ],
        "KeepaliveRequests": 1000,
        "Loadbalance": "iphash"
      },
      "Domain": "www.aliyundoc.com",
      "Cname": "50fqmu1ci7g0xtiyxnrhgx6qdhmn****.yundunwaf5.com"
    }
  ],
  "TotalCount": 24,
  "RequestId": "98D2AA9A-5959-5CCD-83E3-B6606232A2BE"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-08-29	OpenAPI 入参发生变更	查看变更详情
2024-02-22	OpenAPI 返回结构发生变更	查看变更详情
2024-02-20	OpenAPI 返回结构发生变更	查看变更详情
2023-10-19	OpenAPI 返回结构发生变更	查看变更详情