GetKeylessServer - Edge Security Acceleration: Central de Documentação do Alibaba Cloud

Obtém a configuração de um servidor Keyless.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

esa:GetKeylessServer

get

*Site

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SiteId	integer	Sim	O ID do site, que pode ser obtido chamando a operação ListSites.	5407498413****
Id	string	Sim	O ID do servidor Keyless.	baba39055622c008b90285a8838e****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
SiteId	integer	O ID do site.	123456****
SiteName	string	O nome do site.	example.com
Id	string	O ID do servidor Keyless.	baba39055622c008b90285a8838e****
Name	string	O nome do servidor Keyless.	example
Host	string	O nome do host do servidor Keyless.	example.com
Port	integer	A porta do servidor Keyless. Valores válidos: 1 a 65535.	443
Verify	boolean	Indica se o certificado do servidor Keyless deve ser verificado. Valor padrão: false. Valores válidos: true : true. false : false.	true
CaCertificate	string	O certificado de CA usado para verificar o certificado do servidor Keyless. Este parâmetro só entra em vigor quando Verify é definido como true.	-----BEGIN CERTIFICATE-----****
ClientCertificate	string	O certificado do cliente. Este parâmetro deve ser usado em conjunto com a chave privada do cliente.	-----BEGIN CERTIFICATE-----****
ClientPrivateKey	string	A chave privada do cliente. Este parâmetro deve ser usado em conjunto com o certificado do cliente.	-----BEGIN RSA PRIVATE KEY-----****
CreateTime	string	A hora de criação. O horário segue o formato YYYY-MM-DDTHH:MM:SS+08:00 no fuso horário UTC/GMT.	2025-07-18T20:33:31+08:00
UpdateTime	string	A hora de modificação. O horário segue o formato YYYY-MM-DDTHH:MM:SS+08:00 no fuso horário UTC/GMT.	2025-07-18T20:33:31+08:00
RequestId	string	O ID da solicitação.	3558df77-8a7a-4060-a900-2d794940****

Exemplos

Resposta de sucesso

JSON formato

{
  "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": "2025-07-18T20:33:31+08:00",
  "UpdateTime": "2025-07-18T20:33:31+08:00",
  "RequestId": "3558df77-8a7a-4060-a900-2d794940****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	MissingSiteId	Required parameter SiteId missing. Specify SiteId and try again.
400	InternalException	Failed to call the service. Try again later or contact technical support.
400	Id.MissingParameter	The parameter Id is required.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.
403	Unauthorized.InvalidToken	Token authentication failed.
404	Certificate.NotFound	The specified certificate does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.