DescribeTerminalSessions - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Consulta o histórico de sessões do Session Manager.

Descrição da operação

Você pode consultar os registros de sessões do Session Manager criados nos últimos 30 dias. Um máximo de 1.000 registros bem-sucedidos é retido.

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

ecs:DescribeTerminalSessions

list

*Instância.

acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região.	cn-hangzhou
InstanceId	string	Não	O ID da instância.	i-bp1i7gg30r52z2em****
SessionId	string	Não	O ID da sessão.	s-hz023od0x9****
MaxResults	integer	Não	O número máximo de entradas por página para uma consulta paginada. Valor máximo: 100. Valor padrão: 10.	10
NextToken	string	Não	O token de paginação. Defina este parâmetro como o valor NextToken retornado na chamada de API anterior.	AAAAAdDWBF2****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
NextToken	string	O token de paginação retornado nesta chamada.	AAAAAdDWBF2****
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
Sessions	object
Session	array<object>	A lista de sessões.
	array<object>	As informações da sessão.
ClientIP	string	O endereço IP do cliente da conexão remota.	192.168.1.1
Connections	object
Connection	array<object>	A lista de informações de conexão.
	object	As informações da conexão.
ClosedReason	string	O motivo pelo qual a conexão foi fechada. Este parâmetro é retornado apenas quando o Status é Disconnected, Terminated ou Failed. Valores válidos: InstanceNotExists: A instância especificada não existe ou foi liberada. InstanceNotRunning: A instância não está em execução. DeliveryTimeout: A conexão expirou. AgentNeedUpgrade: O Cloud Assistant Agent precisa ser atualizado. AgentNotOnline: O Cloud Assistant Agent não está conectado ao servidor. MessageFormatInvalid: O formato da mensagem é inválido. AgentSocketClosed: A conexão foi fechada normalmente. ClientClosed: O cliente de gerenciamento de sessões fechou a conexão. ReadFromTargetPortFailed: Falha ao ler dados da porta de destino durante o encaminhamento de dados com o PortNumber especificado em StartTerminalSession. ReopenTargetPortFailed: Falha ao restabelecer uma conexão TCP com a porta de destino durante o encaminhamento de dados com o PortNumber especificado em StartTerminalSession. OpenTargetPortFailed: Falha ao estabelecer uma conexão TCP com a porta de destino durante o encaminhamento de dados com o PortNumber especificado em StartTerminalSession. WinptyPermissionDenied: Para instâncias Windows, falha ao conceder ao usuário especificado permissões de leitura e execução em winpty.dll ou winpty-agent.exe. PasswordNameNotFound: O PasswordName especificado em StartTerminalSession não foi encontrado. ProcessSessionDataError: Falha ao processar os dados da sessão. SessionIdDuplicate: O ID da sessão está duplicado. SessionTimeout: A sessão expirou. Uma conexão de sessão que excede 3 horas é desconectada proativamente. IdleTimeout: A conexão expirou. Uma conexão sem interação de sessão por 180 segundos é considerada ociosa e desconectada proativamente. HomeDirPermissionDenied: Permissões insuficientes no diretório inicial do usuário a ser conectado. HomeDirNotFound: O diretório inicial do usuário a ser conectado não existe. ShellCommandPermissionDenied: Permissões insuficientes no programa de shell. bash ou csh não tem permissões de execução. ShellCommandNotFound: O programa de shell não existe. O arquivo bash no Linux, o arquivo csh no FreeBSD ou o arquivo powershell.exe no Windows não existe. ObtainUserInfoFailed: Falha ao obter as informações do parâmetro Username (informações do diretório inicial). ObtainUserIdentityFailed: Falha ao obter as informações de autenticação do parâmetro Username (uid, gid, groups). UserNotExists: O Username especificado em StartTerminalSession não existe. MalformedCommandLine: Falha ao analisar o CommandLine especificado em StartTerminalSession.	AgentNeedUpgrade
EndTime	string	A hora em que a conexão terminou. A hora é exibida no formato ISO 8601 em UTC.	2024-01-19T09:16:46Z
FailedDetail	string	Os detalhes da falha de conexão. Este parâmetro é retornado apenas quando o Status é Failed.	O Session Manager foi fechado normalmente
InstanceId	string	O ID da instância.	i-bp1i7gg30r52z2em****
StartTime	string	A hora em que a conexão começou. A hora é exibida no formato ISO 8601 em UTC.	2024-01-19T09:16:40Z
Status	string	O status da sessão. Valores válidos: Connecting: A sessão está sendo conectada. Connected: A sessão está conectada. Terminated: A sessão foi encerrada. Failed: A conexão falhou.	Connecting
CreationTime	string	A hora em que a sessão foi criada. A hora é exibida no formato ISO 8601 em UTC.	2024-01-19T09:15:46Z
IdentityType	string	O tipo de identidade. Valores válidos: Account: Conta Alibaba Cloud. RAMUser: Usuário do Resource Access Management (RAM). AssumedRoleUser: Função do RAM.	RAMUser
PortNumber	integer	O número da porta da instância ECS usada para encaminhamento de dados. Se nenhum número de porta estiver configurado para encaminhamento de dados, este valor estará vazio.	22
PrincipalId	string	O ID da identidade. O valor varia com base no IdentityType: Se o chamador for uma conta Alibaba Cloud: O ID da conta Alibaba Cloud é retornado. Se o chamador for um usuário do Resource Access Management (RAM): O ID do usuário RAM é retornado. Se o chamador invocar a API por meio de assunção de função: O ID real do delegado da assunção de função é retornado.	123456xxxx
SessionId	string	O ID da sessão.	s-hz023od0x9****
TargetServer	string	O endereço do servidor de destino na VPC acessado por meio da instância.	192.168.0.246
Username	string	O nome de usuário usado para a conexão.	root

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "Sessions": {
    "Session": [
      {
        "ClientIP": "192.168.1.1",
        "Connections": {
          "Connection": [
            {
              "ClosedReason": "AgentNeedUpgrade",
              "EndTime": "2024-01-19T09:16:46Z",
              "FailedDetail": "O Session Manager foi fechado normalmente",
              "InstanceId": "i-bp1i7gg30r52z2em****",
              "StartTime": "2024-01-19T09:16:40Z",
              "Status": "Connecting"
            }
          ]
        },
        "CreationTime": "2024-01-19T09:15:46Z",
        "IdentityType": "RAMUser",
        "PortNumber": 22,
        "PrincipalId": "123456xxxx",
        "SessionId": "s-hz023od0x9****",
        "TargetServer": "192.168.0.246",
        "Username": "root"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	O parâmetro MaxResults especificado é inválido.
500	InternalError	An error occurred when you dispatched the request.	Ocorreu um erro interno. Tente novamente.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	Operation.Forbidden	The operation is not permitted.	A operação não é permitida.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.	O RegionId especificado não existe. Verifique se o produto está disponível nesta região.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.