DescribeVerifyContent - Web Application Firewall - Alibaba Cloud Documentation Center

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:DescribeVerifyContent

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note Call DescribeInstance to query the ID of the WAF instance.	waf_v2_public_cn-***
DomainName	string	Yes	The domain name that you want to query for ownership verification content.	example.com
AccessOrigin	string	Yes	The source of the domain name. Valid values: share: The domain name is added to WAF in CNAME record mode. asset: The domain name is added to WAF as a custom asset. hybrid_cloud_cname: The domain name is added to WAF in hybrid cloud CNAME record mode. tgw: The domain name is added to WAF in cloud native mode.	share

Response elements

Element	Type	Description	Example
	object	The response parameters.
DnsContent	object	The DNS-based verification content, including the TXT record details.
RR	string	The host record of the DNS TXT record used for domain ownership verification.	verification
Type	string	The type of the DNS record used for verification.	TXT
Value	string	The value of the DNS TXT record used for verification.	verify_0a246ca99d504ba087472d***
FileContent	object	The file-based verification content, including the file name, path, and download URL.
TopDomain	string	The root domain of the domain name to be verified.	aliyundemo.com
VerifyPath	string	The URL that is used to access the verification file.	http://xxx.xxx.com//xxx.html
FileName	string	The name of the verification file.	xxx.html
Value	string	The content of the verification file.	verify_0a246ca99d504ba08***
DownloadUrl	string	The download URL of the verification file.	http://oss.xxx.com//xxx.html
RequestId	string	The request ID.	D7861F61-5B61-46CE-A47C-***
VerifyResult	boolean	Indicates whether the domain ownership verification is successful.	true

Examples

Success response

JSON format

{
  "DnsContent": {
    "RR": "verification",
    "Type": "TXT",
    "Value": "verify_0a246ca99d504ba087472d***"
  },
  "FileContent": {
    "TopDomain": "aliyundemo.com",
    "VerifyPath": "http://xxx.xxx.com//xxx.html",
    "FileName": "xxx.html",
    "Value": "verify_0a246ca99d504ba08***",
    "DownloadUrl": "http://oss.xxx.com//xxx.html"
  },
  "RequestId": "D7861F61-5B61-46CE-A47C-***",
  "VerifyResult": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.