ApplyCertificate

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: ApplyCertificate.
Version	Yes	String	Common Params. The value used for this API: 2019-12-05.
Region	No	String	Common Params. This parameter is not required for this API.
DvAuthMethod	Yes	String	Certificate domain validation methods: DNS_AUTO: Automatically add domain DNS validation. Requires the user's domain to be hosted on 'Cloud DNS' and associated with the same Tencent Cloud account as the certificate application. DNS: Manually add domain DNS validation. Requires the user to manually add the validation value at their domain's DNS service provider. FILE: Manually add domain file validation. Requires the user to manually add a specified path file in the root directory of the domain site for file validation. Either HTTP or HTTPS validation will suffice; the domain site must be accessible by overseas CA institutions. The specific access whitelist is: 64.78.193.238, 216.168.247.9, 216.168.249.9, 54.189.196.217.
DomainName	Yes	String	The domain bound to the certificate.
ProjectId	No	Integer	The project ID associated with the certificate. Default is 0 (default project)
PackageType	No	String	Certificate type, optional, currently only type 83 is supported. 83 = trustasia c1 dv free.
ContactEmail	No	String	The email associated with the certificate order, By default, it uses the Tencent Cloud account email. If it does not exist, a fixed email address will be used.
ContactPhone	No	String	The mobile phone number associated with the certificate. If it does not exist, a fixed mobile phone number will be used.
ValidityPeriod	No	String	Certificate valid period, 3 months by default, currently only 3 months is supported.
CsrEncryptAlgo	No	String	Encryption algorithm, values can be ECC or RSA, default is RSA.
CsrKeyParameter	No	String	Key pair parameters. RSA supports only 2048. ECC supports only prime256v1. When the encryption algorithm is set to ECC, this parameter is mandatory.
CsrKeyPassword	No	String	Private key password, currently only used when generating jks, pfx format certificates; private key certificates of other formats are not encrypted.
Alias	No	String	Certificate alias.
OldCertificateId	No	String	Old certificate id, used for certificate renewal (the certificate valid period is within 30 days and not expired), a renewal relationship will be established, which can be hosted; not providing it means applying for a new certificate.
PackageId	No	String	Benefit package ID, used for free certificate expansion package, the free certificate expansion package has been discontinued.
DeleteDnsAutoRecord	No	Boolean	Whether to delete the automatic domain name verification record after issuance, which is fasle by default. This parameter can be passed in only for domain names of the DNS_AUTO verification type.
DnsNames.N	No	Array of String	Other domains bound to the certificate, to be opened. This parameter is not currently supported.

3. Output Parameters

Parameter Name	Type	Description
CertificateId	String	The newly applied certificate id.
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 Applying for a free certificate

This example shows you how to apply for a free certificate.

Input Example

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

{
    "DvAuthMethod": "DNS_AUTO",
    "DomainName": "wgc.red"
}

Output Example

{
    "Response": {
        "CertificateId": "a9TsmZkL",
        "RequestId": "0b39eaa4-f938-476d-9b26-19fb07b80936"
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation	Operation failed.
FailedOperation.AuthError	You do not have permission to perform this operation.
FailedOperation.CancelOrderFailed	Failed to cancel the order.
FailedOperation.CannotBeDeletedIssued	Failed to delete the certificate because it has been issued.
FailedOperation.CannotBeDeletedWithinHour	Free certificates cannot be deleted within 1 hour after being applied for.
FailedOperation.CannotGetOrder	Failed to get order information. Try again later.
FailedOperation.CertificateInvalid	The certificate is invalid.
FailedOperation.CertificateMismatch	The certificate and the private key do not match.
FailedOperation.CertificateNotFound	The certificate does not exist.
FailedOperation.ExceedsFreeLimit	The number of free certificates exceeds the maximum value.
FailedOperation.InvalidCertificateStatusCode	The certificate status is incorrect.
FailedOperation.InvalidParam	Incorrect parameters.
FailedOperation.MainDomainCertificateCountLimit	The number of free certificates applied for under the primary domain name (%s) has reached the upper limit of %s. Please purchase a paid certificate.
FailedOperation.NetworkError	The CA system is busy. Try again later.
FailedOperation.NoProjectPermission	You do not have the permission to operate on this project.
FailedOperation.NoRealNameAuth	You have not completed the identity verification.
FailedOperation.OrderAlreadyReplaced	This order has already been replaced.
FailedOperation.OrderReplaceFailed	Failed to reissue a certificate.
FailedOperation.PackageCountLimit	The remaining benefit points are insufficient.
FailedOperation.PackageExpired	The benefit package has expired.
FailedOperation.PackageNotFound	The benefit package does not exist.
InternalError	Internal error.
InvalidParameter	The parameter is incorrect.
InvalidParameter.PackageIdsInvalid	The list of benefit point IDs is invalid.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Image Creation

Internet of Things

Stream Services

Cloud Real-time Rendering

Management and Audit Tools

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Developer Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Voice Technology

Natural Language Processing

Communication

Media Process Services

Education Sevices

Monitor and Operation

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Tencent Big Model

Optical Character Recognition

Interactive Video Services

Media SDK

Cloud Resource Management

More

1. API Description