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

update

*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 the current WAF instance.	waf_v2_public_cn-*****
DomainName	string	Yes	The domain name that you want to query. Set this parameter to perform a fuzzy query to check whether a domain name is added to WAF.	example.com
VerifyType	string	Yes	The verification method. Valid values: dnsCheck: DNS verification. fileCheck: File verification. Valid values: fileCheck : File verification dnsCheck : DNS verification	dnsCheck
Protocol	string	No	The protocol type used for file verification. This parameter is required only when you set VerifyType to fileCheck. Valid values: HTTP: the HTTP protocol. HTTPS: the HTTPS protocol. Valid values: HTTPS : HTTPS HTTP : HTTP	HTTP

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	F35F45B0-5D6B-4238-BE02-A62D****E840
VerifyResult	object	The verification result.
FailCode	string	The reason why the verification failed. DnsTxtVerifyFailed: The DNS TXT record does not match. DnsServerError: The DNS server is abnormal. VerifyFileNotExist: The verification file does not exist. VerifyDomainNotAccess: Failed to access the domain name. FileContentVerifyFailed: The file content does not match.	DnsTxtVerifyFailed
Result	boolean	The verification result. Valid values: true: The verification is successful. false: The verification failed.	true

Examples

Success response

JSON format

{
  "RequestId": "F35F45B0-5D6B-4238-BE02-A62D****E840",
  "VerifyResult": {
    "FailCode": "DnsTxtVerifyFailed",
    "Result": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.