Queries the details about a domain validated (DV) certificate order.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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
Action String Yes DescribeDVOrderResult

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

SourceIp String No 192.168.XX.XX

The source IP address of the request.

Lang String No zh

The language of the content within the request and response. Valid values:

  • zh: Chinese
  • en: English

Default value: zh.

InstanceId String Yes cas-cn-68n1mm16****

The ID of the certificate instance. You can call the DescribeOrderInstanceList operation to query the ID of a certificate instance.

Response parameters

Parameter Type Example Description
CheckType String DNS

If the value of the OrderStatus parameter is checking, the method of domain name verification is returned. Valid values:

  • DNS: manual DNS verification. If you want to protect a domain name that is not hosted on Alibaba Cloud, you must manually add a TXT record for the domain name on the management platform of your DNS service provider. For example, if you purchase a domain name from Company A, you must manually add a TXT record on the management platform of Company A.
  • FILE: file verification. Alibaba Cloud verifies the ownership of your domain name after you create a specific file on your DNS server.
RequestId String EECA10D5-BD0F-4EF1-B3EA-B4578E5C6F8E

The ID of the request.

Certificate String -----BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----

If the value of the OrderStatus parameter is issued, the CA certificate in the PEM format is returned.

PrivateKey String ----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----

If the value of the OrderStatus parameter is issued, the private key of the certificate in the PEM format is returned.

OrderStatus String checking

The status of the certificate instance. Valid values:

  • checking: The certificate instance is under validation.
  • issued: The certificate instance is issued.
  • checked_fail: The certificate instance failed to be validated.
CheckValue String 201810150000000k09v6d4********

If the value of the OrderStatus parameter is checking, the value used for domain name verification is returned.

CheckName String _xx.aliyundns2018****

If the value of the OrderStatus parameter is checking, the name used for the domain name verification is returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDVOrderResult
&SourceIp=1.2.XX.XX
&Lang=zh
&InstanceId=cas-cn-68n1mm16****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDVOrderResultResponse>
    <CheckType>DNS</CheckType>
    <RequestId>EECA10D5-BD0F-4EF1-B3EA-B4578E5C6F8E</RequestId>
    <Certificate>-----BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----</Certificate>
    <PrivateKey>----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----</PrivateKey>
    <OrderStatus>checking</OrderStatus>
    <CheckValue>201810150000000k09v6d4........</CheckValue>
    <CheckName>_xx.aliyundns2018****</CheckName>
</DescribeDVOrderResultResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "CheckType" : "DNS",
  "RequestId" : "EECA10D5-BD0F-4EF1-B3EA-B4578E5C6F8E",
  "Certificate" : "-----BEGIN CERTIFICATE----- MIIF...... -----END CERTIFICATE-----",
  "PrivateKey" : "----BEGIN RSA PRIVATE KEY----- MII.... -----END RSA PRIVATE KEY-----",
  "OrderStatus" : "checking",
  "CheckValue" : "201810150000000k09v6d4........",
  "CheckName" : "_xx.aliyundns2018****"
}

Error codes

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