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

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

esa:SetKeylessServer

none

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. You can call the ListSites operation to obtain the site ID.	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 port of the Keyless server.	443
Verify	boolean	No	Specifies whether to verify the server certificate of the Keyless server. Default value: false.	true
CaCertificate	string	No	The CA certificate used to verify the server certificate of the Keyless server. This parameter takes effect only when Verify is set to true.	-----BEGIN CERTIFICATE-----****
ClientCertificate	string	No	The client certificate. This parameter must be specified together with the client private key.	-----BEGIN CERTIFICATE-----****
ClientPrivateKey	string	No	The client private key. This parameter must be specified together with the client certificate.	-----BEGIN RSA PRIVATE KEY-----****
Id	string	No	Keyless server ID。	baba39055622c008b90285a8838e****
Name	string	Yes	The name of the Keyless server.	example

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	34DCBC8A-**--**-6DAA11D7DDBD
Id	string	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.
400	LockFailed	The system is handling requests you previously submitted. Try again later.	The system is handling requests you previously submitted. Try again later.
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.