All Products
Search

This Product

    Direct Mail:CheckDomain

    Document Center

    Direct Mail:CheckDomain

    Last Updated:Aug 10, 2023

    Verifies a domain name.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

    Request parameters

    Parameter

    Type

    Required

    Example

    Description

    DomainId

    Integer

    Yes

    153345

    The ID of the domain name.

    Action

    String

    Yes

    CheckDomain

    The operation that you want to perform. Set the value to CheckDomain.

    Response parameters

    Parameter

    Type

    Example

    Description

    DomainStatus

    Integer

    1

    The status of the domain name. Indicates whether the domain name is verified and available.

    • 0: indicates that the domain name is verified and available.

    • 1: indicates that the domain name fails to be verified and is unavailable.

    • 2: indicates that the domain name is available, but not filed or configured with a CNAME record.

    • 3: indicates that the domain name is available but not filed.

    • 4: indicates that the domain name is available but not configured with a CNAME record.

    RequestId

    String

    F0B82E83-A1D9-4FE6-97D2-F4B231F80B02

    The ID of the request.

    Examples

    Sample requests

    http(s)://dm.aliyuncs.com/? Action=CheckDomain
&DomainId=153345
&<Common request parameters>

    Sample success responses

    XML format 

    <CheckDomainResponse>
      <DomainStatus>1</DomainStatus>
      <RequestId>F0B82E83-A1D9-4FE6-97D2-F4B231F80B02</RequestId>
</CheckDomainResponse>

    JSON format 

    {
        "RequestId":"F0B82E83-A1D9-4FE6-97D2-F4B231F80B02",
        "DomainStatus":1
}

    Error codes

    For a list of error codes, visit the API Error Center.