tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

VerifyOwnership

Last updated: 2024-04-09 10:25:31

    1. API Description

    Domain name for API request: teo.tencentcloudapi.com.

    This API is used to verify your ownership of a site or domain name. It's required in the CNAME access mode. After a site is verified, you don't need to verify the ownership again for domain names added to it in the future. For details, see Ownership Verification.

    For sites connected via the NS, you can query whether the NS is successfully switched through this API. For details, see Modifying DNS Servers.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: VerifyOwnership.
    Version Yes String Common Params. The value used for this API: 2022-09-01.
    Region No String Common Params. This parameter is not required.
    Domain Yes String Site or acceleration domain name

    3. Output Parameters

    Parameter Name Type Description
    Status String Result of ownership verification
  • success: Verification passed
  • fail: Verification failed
    		•
    Result String When the ownership verification result is fail, this field returns the reason of failure.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Verifying domain ownership (CNAME access)

    Verify the ownership of the domain name test.example.com.

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyOwnership
<Common request parameters>

{
    "Domain": "test.example.com"
}

    Output Example

    {
    "Response": {
        "Status": "success",
        "Result": "",
        "RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"
    }
}

    Example2 Verifying the site ownership (for sites connected with CNAME)

    Verify ownership of site example.com (Site ID: zone-xxxxx).

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyOwnership
<Common request parameters>

{
    "Domain": "example.com"
}

    Output Example

    {
    "Response": {
        "Status": "fail",
        "Result": "Resolve XX and get the xx content xx.\nTried to access  http://xxx/.. . Failed to connect to the resolution  xx .",
        "RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"
    }
}

    Example3 Verifying whether the DNS server is switched (for sites connected with NS)

    This example shows you how to verify whether the DNS of example.com is switched successfully.

    Input Example

    POST / HTTP/1.1
Host: teo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: VerifyOwnership
<Common request parameters>

{
    "Domain": "example.com"
}

    Output Example

    {
    "Response": {
        "Status": "fail",
        "Result": "The  DNS  server of the current domain is  xxx. It does not match the expected server  xxx .",
        "RequestId": "9kl50bew-89ga-44f4-91ce-78125d53vd2a"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError.RouteError The backend routing address is incorrect.
    OperationDenied.ResourceLockedTemporary This operation conflicts with concurrent operations. Try again later.
    ResourceNotFound The resource doesn’t exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy