DescribeCertificateState - Certificate Management Service

Queries the status of a specified certificate application order.

Operation description

If you do not complete the verification of the domain name ownership after you submit a certificate application, you can call this operation to obtain the information that is required to complete the verification. You can complete the verification of the domain name ownership based on the data returned. If you use the DNS verification method, you must complete the verification on the management platform of the domain name. If you use the file verification method, you must complete the verification on the DNS server.

The certificate authority (CA) reviews your certificate application only after you complete the verification of the domain name ownership. After the CA approves your certificate application, the CA issues the certificate. If a certificate is issued, you can call this operation to obtain the CA certificate and private key of the certificate.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cert:DescribeCertificateState	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
OrderId	long	Yes	The ID of the certificate application order that you want to query. Note After you call the CreateCertificateForPackageRequest , CreateCertificateRequest , or CreateCertificateWithCsrRequest operation to submit a certificate application, you can obtain the ID of the certificate application order from the OrderId response parameter.	123451222

Response parameters

Parameter	Type	Description	Example
	object
Type	string	The status of the certificate application order. Valid values: domain_verify: pending review, which indicates that you have not completed the verification of the domain name ownership after you submit the certificate application. Note After you submit a certificate application, you must manually complete the verification of the domain name ownership. The CA reviews the certificate application only after the verification is complete. If you have not completed the verification of the domain name ownership, you can complete the verification based on the data returned by this operation. process: being reviewed, which indicates that the certificate application is being reviewed by the CA. verify_fail: review failed, which indicates that the certificate application failed to be reviewed. Note If a certificate application fails to be reviewed, the information that you specified in the certificate application may be incorrect. We recommend that you call the DeleteCertificateRequest operation to delete the certificate application order and resubmit a certificate application. After the order is deleted, the quota that is consumed for the order is released. certificate: issued, which indicates that the certificate is issued. payed: pending application, which indicates that you have not submitted a certificate application. unknow: The status is unknown.	domain_verify
Domain	string	The domain name to be verified when you use the file verification method. You must connect to the DNS server of the domain name and create a file on the server. The file is specified by the Uri parameter. Note This parameter is returned only when the value of the Type parameter is domain_verify and the value of the ValidateType parameter is FILE. The value domain_verify indicates that the verification of the domain name ownership is not complete, and the value FILE indicates that the file verification method is used.	www.example.com
RecordType	string	The type of the DNS record that you need to add when you use the DNS verification method. Valid values: TXT CNAME Note This parameter is returned only when the value of the Type parameter is domain_verify and the value of the ValidateType parameter is DNS. The value domain_verify indicates that the verification of the domain name ownership is not complete.	TXT
Certificate	string	The content of the certificate in the PEM format. For more information about the PEM format and how to convert certificate formats, see What formats are used for mainstream digital certificates? Note This parameter is returned only when the value of the Type parameter is certificate. The value certificate indicates that the certificate is issued.	-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----
RequestId	string	The ID of the request.	082FAB35-6AB9-4FD5-8750-D36673548E76
RecordDomain	string	The DNS record that you need to manage when you use the DNS verification method. Note This parameter is returned only when the value of the Type parameter is domain_verify and the value of the ValidateType parameter is DNS. The value domain_verify indicates that the verification of the domain name ownership is not complete, and the value DNS indicates that the DNS verification method is used.	_dnsauth
PrivateKey	string	The private key of the certificate in the PEM format. For more information about the PEM format and how to convert certificate formats, see What formats are used for mainstream digital certificates? Note This parameter is returned only when the value of the Type parameter is certificate. The value certificate indicates that the certificate is issued.	-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----
ValidateType	string	The verification method of the domain name ownership. Valid values: DNS: DNS verification. If you use this method, you must add a TXT record to the DNS records of the domain name in the management platform of the domain name. FILE: file verification. If you use this method, you must create a specified file on the DNS server. Note This parameter is returned only when the value of the Type parameter is domain_verify. The value domain_verify indicates that the verification of the domain name ownership is not complete.	FILE
RecordValue	string	You need to add a TXT record to the DNS records only when you use the DNS verification method. Note This parameter is returned only when the value of the Type parameter is domain_verify and the value of the ValidateType parameter is DNS. The value domain_verify indicates that the verification of the domain name ownership is not complete, and the value DNS indicates that the DNS verification method is used.	20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy
Content	string	The content that you need to write to the newly created file when you use the file verification method. Note This parameter is returned only when the value of the Type parameter is domain_verify and the value of the ValidateType parameter is FILE. The value domain_verify indicates that the verification of the domain name ownership is not complete, and the value FILE indicates that the file verification method is used.	http://example.com/.well-known/pki-validation/fileauth.txt
Uri	string	The file that you need to create on the DNS server when you use the file verification method. The value of this parameter contains the file path and file name. Note This parameter is returned only when the value of the Type parameter is domain_verify and the value of the ValidateType parameter is FILE. The value domain_verify indicates that the verification of the domain name ownership is not complete, and the value FILE indicates that the file verification method is used.	/.well-known/pki-validation/fileauth.txt

Examples

Sample success responses

JSONformat

{
  "Type": "domain_verify",
  "Domain": "www.example.com",
  "RecordType": "TXT",
  "Certificate": "-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----",
  "RequestId": "082FAB35-6AB9-4FD5-8750-D36673548E76",
  "RecordDomain": "_dnsauth",
  "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----…… -----END RSA PRIVATE KEY-----",
  "ValidateType": "FILE",
  "RecordValue": "20200420000000223erigacv46uhaubchcm0o7spxi7i2isvjq59mlx9lucnkqcy",
  "Content": "http://example.com/.well-known/pki-validation/fileauth.txt",
  "Uri": "/.well-known/pki-validation/fileauth.txt"
}

Error codes

For a list of error codes, visit the Service error codes.