DescribeHybridCloudResourceDetail - 查询混合云域名详情_Web应用防火墙(WAF)-阿里云帮助中心

查询混合云域名详情

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:DescribeHybridCloudResourceDetail

get

*全部资源

*

acs:ResourceGroupId

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例 ID。说明您可以通过调用 DescribePayInfo 接口查看您当前 WAF 实例 ID。	waf-cn-0xldbqt****
Domain	string	是	域名	www.*****.com
Backend	string	否	回源地址	1.1.XX.XX
PageNumber	integer	否	查询页码，默认值是 1。	1
PageSize	integer	否	每页显示条数。	10
CnameEnabled	boolean	否	是否开启公共云容灾。取值： true：表示开启公共云容灾。 false：表示不开启公共云容灾。	true
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	66A98669-CC6E-4F3E-80A6-3014697B11AE
Domain	object	域名信息。
Status	integer	资源状态。	1
ResourceManagerResourceGroupId	string	资源组 ID。	rg-***aby
Uid	string	用户 ID。	1046011128270720
Listen	object	监听信息。
HttpsPorts	array	HTTPS 协议的端口。
	integer	HTTPS 协议的端口。	443,8443,7443,6443
ProtectionResource	string	要使用的防护资源类型。取值： share：表示使用共享集群。 gslb：表示使用共享集群智能负载均衡。	share
CustomCiphers	array	自定义加密套件。
	string	自定义加密套件。	ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384
TLSVersion	string	TLS 的版本。取值： tlsv1 tlsv1.1 tlsv1.2	tlsv1
Http2Enabled	boolean	是否开启 HTTP2。取值： true：表示开启 HTTP2。 false：表示不开启 HTTP2。	true
CertId	string	证书的 ID。	19312542-cn-hangzhou
CipherSuite	integer	加密套件类型。取值： 1：表示添加全部加密套件。 2：表示添加强加密套件。 99：表示添加自定义加密套件。	0
EnableTLSv3	boolean	是否支持 TLS1.3 版本。取值： true：表示支持 TLS1.3 版本。 false：表示不支持 TLS1.3 版本。	true
IPv6Enabled	boolean	开启 IPv6 是否开启 IPv6。取值： true：表示开启 IPv6。 false：表示不开启 IPv6。	true
FocusHttps	boolean	是否开启 HTTPS 的强制跳转。取值： true：表示开启 HTTPS 的强制跳转。 false：表示不开启 HTTPS 的强制跳转。	true
XffHeaders	array	设置用于获取客户端 IP 的自定义字段列表，使用["header1","header2",……]格式表示。说明仅在 XffHeaderMode 取值为 2（表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP）时，需要设置该参数。
	string	设置用于获取客户端 IP 的自定义字段列表，使用["header1","header2",……]格式表示。说明仅在 XffHeaderMode 取值为 2（表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP）时，需要设置该参数。	["test"]
XffHeaderMode	integer	WAF 获取客户端真实 IP 的方式。取值： 0：表示客户端访问流量到 WAF 前没有经过其他七层代理转发。 1：表示 WAF 读取请求头中 X-Forwarded-For（XFF）字段的第一个值作为客户端 IP。 2：表示 WAF 读取请求头中由您设置的自定义字段值作为客户端 IP。	1
ExclusiveIp	boolean	是否支持独享 IP。取值： true：表示支持。 false：表示不支持。	true
HttpPorts	array	HTTP 协议的可用端口列表。取值为字符串，多个端口时，使用port1,port2,port3的格式返回。
	integer	HTTP 协议的可用端口列表。取值为字符串，多个端口时，使用port1,port2,port3的格式返回。	80,8080,9080,9081,9082,8182
Id	integer	id	31323
Redirect	object	返回响应头值的规则
ConnectTimeout	integer	连接超时时间：单位毫秒	1
Keepalive	boolean	是否保持长连接。取值： true（默认）：表示保持长连接。 false：表示不保持长连接。	true
SniEnabled	boolean	是否开启回源 SNI。取值： true：表示开启回源 SNI。 false：表示不开启回源 SNI。	true
CnameEnabled	boolean	是否开启公共云容灾。取值： true：表示开启公共云容灾。 false：表示不开启公共云容灾。	true
KeepaliveTimeout	integer	长连接的空闲超时时间。	1
ReadTimeout	integer	请求的 read 超时时间。	1
Backends	array	源站服务器 IP 或服务器回源域名。
	string	源站服务器 IP 或服务器回源域名。	1.1.1.1
SniHost	string	SNI 扩展字段的自定义值。取值为空表示未自定义 SNI 值，默认使用请求头中 Host 字段的值作为 SNI 扩展字段的值。说明仅在 SniStatus 取值为 1（表示开启 SNI 回源）时，返回该参数。	eew111
FocusHttpBackend	boolean	是否开启强制 HTTP 回源。取值： true：表示开启强制 HTTP 回源。 false：表示不开启强制 HTTP 回源。	true
WriteTimeout	integer	写超时时长，单位：毫秒。	1
RoutingRules	string	混合云转发规则。使用 JSON 数组转化的字符串格式表示。JSON 数组中的每个元素是一个结构体，包含以下字段： rs：Array 类型	[{\"backupRs\":[],\"location\":\"v3-test\",\"locationId\":1148,\"rs\":[\"39.98.217.197\",\"2.2.2.2\"]}]
Retry	boolean	WAF 回源失败时，是否重试。取值： true：表示重试。 false：表示不重试。	true
RequestHeaders	array<object>	HTTP 请求头。
	object	指定的自定义请求头部字段。
Value	string	数值。	9506360478730
Key	string	标签的 Key	L2x1ZmZ5L2NvcmUvYXBwcy9tLnl1bmR1bi53YWYuMS9wbHVnaW5z
KeepaliveRequests	integer	复用长连接的请求个数。取值范围：60~1000，单位：个。说明开启长连接后，复用多少个长连接。	1000
Loadbalance	string	回源时采用的负载均衡算法。取值： iphash：表示 IP Hash 算法。 roundRobin：表示轮询算法。 leastTime：表示 Least Time 算法。	iphash
Domain	string	域名	www.*****.com
Cname	string	CNAME	kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com

示例

正常返回示例

JSON格式

{
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "Domain": {
    "Status": 1,
    "ResourceManagerResourceGroupId": "rg-***aby",
    "Uid": "1046011128270720",
    "Listen": {
      "HttpsPorts": [
        0
      ],
      "ProtectionResource": "share",
      "CustomCiphers": [
        "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384"
      ],
      "TLSVersion": "tlsv1",
      "Http2Enabled": true,
      "CertId": "19312542-cn-hangzhou",
      "CipherSuite": 0,
      "EnableTLSv3": true,
      "IPv6Enabled": true,
      "FocusHttps": true,
      "XffHeaders": [
        "[\"test\"]"
      ],
      "XffHeaderMode": 1,
      "ExclusiveIp": true,
      "HttpPorts": [
        0
      ]
    },
    "Id": 31323,
    "Redirect": {
      "ConnectTimeout": 1,
      "Keepalive": true,
      "SniEnabled": true,
      "CnameEnabled": true,
      "KeepaliveTimeout": 1,
      "ReadTimeout": 1,
      "Backends": [
        "1.1.1.1"
      ],
      "SniHost": "eew111",
      "FocusHttpBackend": true,
      "WriteTimeout": 1,
      "RoutingRules": "[{\\\"backupRs\\\":[],\\\"location\\\":\\\"v3-test\\\",\\\"locationId\\\":1148,\\\"rs\\\":[\\\"39.98.217.197\\\",\\\"2.2.2.2\\\"]}]",
      "Retry": true,
      "RequestHeaders": [
        {
          "Value": "9506360478730",
          "Key": "L2x1ZmZ5L2NvcmUvYXBwcy9tLnl1bmR1bi53YWYuMS9wbHVnaW5z"
        }
      ],
      "KeepaliveRequests": 1000,
      "Loadbalance": "iphash"
    },
    "Domain": "www.*****.com",
    "Cname": "kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com"
  }
}

错误码

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

变更历史

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