SetKeylessServer - Edge Security Acceleration - Alibaba Cloud Documentation Center

Creates or updates a keyless server configuration.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID, which can be obtained by calling the ListSites operation.	123456****
Host	string	Yes	The hostname of the keyless server. The value can be a domain name or an IP address.	keyless.example.com
Port	integer	Yes	The keyless server port.	443
Verify	boolean	No	Whether to verify the server certificate of the keyless server. Default value: false.	true
CaCertificate	string	No	The CA certificate used to verify the keyless server certificate. This parameter takes effect only when `Verify` is set to `true`.	-----BEGIN CERTIFICATE-----****
ClientCertificate	string	No	The client certificate. Must be used together with the `ClientPrivateKey` parameter.	-----BEGIN CERTIFICATE-----****
ClientPrivateKey	string	No	The client private key. Must be used together with the `ClientCertificate` parameter.	-----BEGIN RSA PRIVATE KEY-----****
Id	string	No	The keyless server ID.	baba39055622c008b90285a8838e****
Name	string	Yes	The keyless server name.	example

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	34DCBC8A-**--**-6DAA11D7DDBD
Id	string	The keyless server ID.	babaabcd****
SiteId	integer	The site ID.	123456****
SiteName	string	The site name.	example.com

Examples

Success response

JSON format

{
  "RequestId": "34DCBC8A-****-****-****-6DAA11D7DDBD",
  "Id": "babaabcd****",
  "SiteId": 0,
  "SiteName": "example.com"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Certificate.Duplicated	The certificate name already exists.	The certificate is duplicated.
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InvalidCertificate.NotFound	The specified certificate does not match the website. Check the validity of the certificate and try again.	The specified certificate does not match the website. Check the validity of the certificate and try again.
400	PrivateKey.MissingParameter	The PrivateKey parameter is required.	Missing PrivateKey parameter.
400	Certificate.MissingParameter	The Certificate parameter is required.	Missing Certificate parameter.
400	InvalidParameter.SiteId	Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.	Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again.
400	InvalidSSLPub	The specified Certificate is invalid.	The value specified for the Certificate parameter is invalid.
400	InvalidSSLPri	The specified PrivateKey is invalid.	The value specified for the PrivateKey parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.
400	UpdateFreeCertificate.NotSupport	The free certificate does not support the update operation.	The free certificate does not support the update operation.
400	CertificateDomainNotMatchSite	The domain name in the specified certificate does not match the site.	The domain name in the certificate does not match the current site.
400	CertificateNotMatchPrivateKey	The specified certificate does not match the private key.	The specified certificate and private key do not match.
400	CertQuotaCheckFailed	The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.	The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.
404	Certificate.NotFound	The specified certificate does not exist.	The specified certificate does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.