StartTerminalSession - Simple Application Server: Central de Documentação do Alibaba Cloud

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

swas-open:StartTerminalSession

none

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região da instância do Simple Application Server. Você pode chamar a operação ListRegions para consultar a lista mais recente de regiões da Alibaba Cloud.	cn-hangzhou
InstanceId	string	Sim	O ID da instância do Simple Application Server.	ace0706b2ac4454d984295a94213****
CommandLine	string	Não	O comando a ser executado após o início da sessão. O comando pode ter até 512 caracteres.	ssh root@192.168.0.***

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	20758A-585D-4A41-A9B2-28DA8F4F****
SessionId	string	O ID da sessão.	ffb90b6e-b18a-4a33-88cf-86fb88****
SecurityToken	string	O token de segurança incluído no cabeçalho da solicitação WebSocket para autenticação.	token-xxxaaz
WebSocketUrl	string	A URL da sessão WebSocket usada para conectar remotamente à instância do Simple Application Server. A URL contém o ID da sessão (SessionId) e o token de segurança (SecurityToken) usado para autenticação.	wss://xxxx

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F****",
  "SessionId": "ffb90b6e-b18a-4a33-88cf-86fb88****",
  "SecurityToken": "token-xxxaaz",
  "WebSocketUrl": "wss://xxxx"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	UserBehaviour.SessionManagerDisabled	The API is disabled by user behaviour.	User remote connection via session management is turned off.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.