Use SetCdnDomainCSRCertificate to configure an SSL certificate for a domain - CDN - Alibaba Cloud - CDN

Operation description

Note

Each account can call this operation up to 100 times per second.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cdn:SetCdnDomainCSRCertificate

update

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
ServerCertificate	string	Yes	The content of the certificate. The certificate must match the certificate signing request (CSR) created by calling the CreateCdnCertificateSigningRequest operation. Make sure that the content of the certificate is encoded in Base64 and then encoded by encodeURIComponent.	----BEGIN CERTIFICATE----- MIIFz****-----END CERTIFICATE-----
DomainName	string	Yes	The accelerated domain name for which you want to configure an SSL certificate. The domain name must have HTTPS secure acceleration enabled.	example.com

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	0AEDAF20-4DDF-4165-8750-47FF9C1929C9

Examples

Success response

JSON format

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Certificate.MissingParameter	You must specify the Certificate parameter.	You must specify the Certificate parameter.
400	Certificate.EncodeError	An error occurred while encoding the certificate.
400	Certificate.DecodeError	An error occurred while decoding the certificate.
400	Certificate.FormatError	The format of the certificate is invalid.	The specified certificate is invalid.
400	Certificate.MissMatch	The certificate does not match the domain.	The certificate and domain name do not match.
400	Certificate.NoPrivateKey	The private key of the certificate does not exist.
500	Internal.ForbidError	You cannot modify the configurations when some features of the domain are in a canary deployment.	This domain cannot be changed because a feature is in canary release.
500	Internal.ConfigError	An error occurred while configuring the certificate.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.