DescribeHybridCloudResourceDetail - Web Application Firewall

Queries the details of a domain name in a hybrid cloud.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-waf:DescribeHybridCloudResourceDetail

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call the DescribeInstance operation to query the ID of your WAF instance.	waf-cn-0xldbqt****
Domain	string	Yes	The domain name.	www.*****.com
Backend	string	No	The origin URL.	1.1.XX.XX
PageNumber	integer	No	The page number. The default value is 1.	1
PageSize	integer	No	The number of entries to return on each page.	10
CnameEnabled	boolean	No	Specifies whether to enable public cloud disaster recovery. Valid values: true: enables public cloud disaster recovery. false: does not enable public cloud disaster recovery.	true
RegionId	string	No	The region where the WAF instance is deployed. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the Alibaba Cloud resource group.	rg-acfm***q

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	66A98669-CC6E-4F3E-80A6-3014697B11AE
Domain	object	The information about the domain name.
Status	integer	The status of the resource.	1
ResourceManagerResourceGroupId	string	The ID of the resource group.	rg-***aby
Uid	string	The user ID.	1046011128270720
Listen	object	The listener information.
HttpsPorts	array	The HTTPS ports.
	integer	An HTTPS port.	443,8443,7443,6443
ProtectionResource	string	The type of the protection resource to be used. Valid values: share: shared cluster. gslb: intelligent load balancing for shared clusters.	share
CustomCiphers	array	The custom cipher suites.
	string	A custom cipher suite.	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	The TLS version. Valid values: tlsv1 tlsv1.1 tlsv1.2	tlsv1
Http2Enabled	boolean	Specifies whether to enable HTTP/2. Valid values: true: enables HTTP/2. false: does not enable HTTP/2.	true
CertId	string	The ID of the certificate.	19312542-cn-hangzhou
CipherSuite	integer	The type of the cipher suite. Valid values: 1: all cipher suites. 2: strong cipher suites. 99: custom cipher suites.	0
EnableTLSv3	boolean	Specifies whether TLS 1.3 is supported. Valid values: true: TLS 1.3 is supported. false: TLS 1.3 is not supported.	true
IPv6Enabled	boolean	Specifies whether to enable IPv6. Valid values: true: enables IPv6. false: does not enable IPv6.	true
FocusHttps	boolean	Specifies whether to enable a forced redirect to HTTPS. Valid values: true: enables a forced redirect to HTTPS. false: does not enable a forced redirect to HTTPS.	true
XffHeaders	array	The custom header fields used to obtain client IP addresses. The value is in the ["header1","header2",...] format. Note This parameter is required only when XffHeaderMode is set to 2. If XffHeaderMode is set to 2, WAF obtains the client IP address from a custom header field.
	string	A custom header field used to obtain the client IP address. The value is in the ["header1","header2",...] format. Note This parameter is required only when XffHeaderMode is set to 2. If XffHeaderMode is set to 2, WAF obtains the client IP address from a custom header field.	["test"]
XffHeaderMode	integer	The method that WAF uses to obtain the real IP address of a client. Valid values: 0: No Layer 7 proxies are deployed between clients and WAF. 1: WAF reads the first value of the X-Forwarded-For (XFF) header field to obtain the client IP address. 2: WAF reads the value of a custom header field that you specify to obtain the client IP address.	1
ExclusiveIp	boolean	Specifies whether to use an exclusive IP address. Valid values: true: uses an exclusive IP address. false: does not use an exclusive IP address.	true
HttpPorts	array	The list of available HTTP ports. The value is a string. If you specify multiple ports, separate them with commas (,). Example: port1,port2,port3.
	integer	An available HTTP port. The value is a string. If you specify multiple ports, separate them with commas (,). Example: port1,port2,port3.	80,8080,9080,9081,9082,8182
Id	integer	The ID.	31323
Redirect	object	The rule for the value of the response header.
ConnectTimeout	integer	The connection timeout. Unit: milliseconds.	1
Keepalive	boolean	Specifies whether to enable persistent connections. Valid values: true (default): enables persistent connections. false: does not enable persistent connections.	true
SniEnabled	boolean	Specifies whether to enable back-to-origin Server Name Indication (SNI). Valid values: true: enables back-to-origin SNI. false: does not enable back-to-origin SNI.	true
CnameEnabled	boolean	Specifies whether to enable public cloud disaster recovery. Valid values: true: enables public cloud disaster recovery. false: does not enable public cloud disaster recovery.	true
KeepaliveTimeout	integer	The idle timeout of a persistent connection.	1
ReadTimeout	integer	The read timeout of a request.	1
Backends	array	The IP address or domain name of the origin server.
	string	The IP address or domain name of the origin server.	1.1.1.1
SniHost	string	The custom value of the SNI extension field. If this parameter is left empty, the value of the Host field in the request header is used as the value of the SNI extension field. Note This parameter is returned only if SniEnabled is set to true.	eew111
FocusHttpBackend	boolean	Specifies whether to enable a forced back-to-origin request over HTTP. Valid values: true: enables a forced back-to-origin request over HTTP. false: does not enable a forced back-to-origin request over HTTP.	true
WriteTimeout	integer	The write timeout. Unit: milliseconds.	1
RoutingRules	string	The forwarding rules for the hybrid cloud. The value is a string that consists of a JSON array. Each element in the array is a struct that contains the following field: rs: an array.	[{\"backupRs\":[],\"location\":\"v3-test\",\"locationId\":1148,\"rs\":[\"39.98.217.197\",\"2.2.2.2\"]}]
Retry	boolean	Specifies whether to retry a request if the request fails to be sent to the origin server. Valid values: true: retries the request. false: does not retry the request.	true
RequestHeaders	array<object>	The HTTP request headers.
	object	The specified custom request header field.
Value	string	The value of the header field.	9506360478730
Key	string	The key of the header field.	L2x1ZmZ5L2NvcmUvYXBwcy9tLnl1bmR1bi53YWYuMS9wbHVnaW5z
KeepaliveRequests	integer	The number of requests that can be reused in a persistent connection. Valid values: 60 to 1,000. Unit: requests. Note After you enable persistent connections, you can specify the number of requests that can be reused.	1000
Loadbalance	string	The load balancing algorithm for back-to-origin requests. Valid values: iphash: IP hash. roundRobin: round-robin. leastTime: least time.	iphash
Domain	string	The domain name.	www.*****.com
Cname	string	The canonical name (CNAME).	kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com

Examples

Success response

JSON format

{
  "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"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.