GetKeylessServer - Edge Security Acceleration - Alibaba Cloud Documentation Center

Retrieves the configuration of a keyless server.

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. To obtain this ID, call the ListSites operation.	5407498413****
Id	string	Yes	The keyless server ID.	baba39055622c008b90285a8838e****

Response elements

Element	Type	Description	Example
	object	The response schema.
SiteId	integer	The site ID.	123456****
SiteName	string	The site name.	example.com
Id	string	The keyless server ID.	baba39055622c008b90285a8838e****
Name	string	The keyless server name.	example
Host	string	The hostname of the keyless server.	example.com
Port	integer	The port of the keyless server. Valid values: 1 to 65535.	443
Verify	boolean	Indicates whether to verify the server certificate of the keyless server. The default value is false. Valid values: true : Verifies the server certificate of the keyless server. false : Does not verify the server certificate of the keyless server. (Default)	true
CaCertificate	string	The CA certificate used to verify the server certificate of the keyless server. This parameter applies only when Verify is set to true.	-----BEGIN CERTIFICATE-----****
ClientCertificate	string	The client certificate. Must be provided as a pair with the client private key.	-----BEGIN CERTIFICATE-----****
ClientPrivateKey	string	The client private key. Must be provided as a pair with the client certificate.	-----BEGIN RSA PRIVATE KEY-----****
CreateTime	string	The creation time.	2024-03-11T01:23:21Z
UpdateTime	string	The update time.	2025-03-13T02:13:28Z
RequestId	string	The request ID.	3558df77-8a7a-4060-a900-2d794940****

Examples

Success response

JSON format

{
  "SiteId": 0,
  "SiteName": "example.com",
  "Id": "baba39055622c008b90285a8838e****",
  "Name": "example",
  "Host": "example.com",
  "Port": 443,
  "Verify": true,
  "CaCertificate": "-----BEGIN CERTIFICATE-----****",
  "ClientCertificate": "-----BEGIN CERTIFICATE-----****",
  "ClientPrivateKey": "-----BEGIN RSA PRIVATE KEY-----****",
  "CreateTime": "2024-03-11T01:23:21Z\n",
  "UpdateTime": "2025-03-13T02:13:28Z",
  "RequestId": "3558df77-8a7a-4060-a900-2d794940****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingSiteId	Required parameter SiteId missing. Specify SiteId and try again.	Required parameter SiteId missing. Specify SiteId and try again.
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	Id.MissingParameter	The parameter Id is required.	The required parameter Id is missing.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	The authentication time parameter you entered is invalid. Check the parameter value and try again.
403	Unauthorized.InvalidToken	Token authentication failed.	The token you entered is invalid. Please check and enter the correct token and try again.
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.