GetWebshellToken - Serverless App Engine: Central de Documentação do Alibaba Cloud

Obtém o token usado para fazer login remoto no Webshell de uma instância.

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

sae:GetWebshellToken

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /pop/v1/sam/instance/webshellToken HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AppId	string	Sim	O ID do aplicativo de mensagens interativas.	017f39b8-dfa4-4e16-a84b-1dcee4b1****
PodName	string	Sim	O nome do pod.	hello-podsdfsdfsdfsdf
ContainerName	string	Não	O nome do contêiner de inicialização. Nota: Se você especificar este parâmetro, o Cloud Assistant executa o comando no contêiner especificado das instâncias. Se este parâmetro for especificado, o comando poderá ser executado apenas em instâncias Linux nas quais o Cloud Assistant Agent 2.2.3.344 ou posterior esteja instalado. Para obter informações sobre como consultar a versão do Cloud Assistant Agent, consulte Instalar o Cloud Assistant Agent. Para obter informações sobre como atualizar o Cloud Assistant Agent, consulte Atualizar ou desativar atualizações do Cloud Assistant Agent. Se este parâmetro for especificado, o parâmetro Username especificado em uma solicitação para chamar esta operação e o parâmetro WorkingDir especificado em uma solicitação para chamar a operação CreateCommand não terão efeito. Você pode executar o comando apenas no diretório de trabalho padrão do contêiner usando o usuário padrão do contêiner. Para obter mais informações, consulte Usar o Cloud Assistant para executar comandos em contêineres. Se este parâmetro for especificado, apenas scripts de shell poderão ser executados em contêineres Linux. Você não pode adicionar um comando no formato semelhante a `#!/usr/bin/python` no início de um script para especificar um interpretador de script. Para obter mais informações, consulte Usar o Cloud Assistant para executar comandos em contêineres.	ad-helper

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	A mensagem retornada. Descrição do valor: Se a solicitação for bem-sucedida, uma mensagem de sucesso será retornada. Um código de erro será retornado se a solicitação falhar.	success
TraceId	string	O ID do rastreamento.	0a98a02315955564772843261e****
Data	object	O resultado retornado.
Token	string	As informações sobre o token.	zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7
HttpUrl	string	O endereço da página do Webshell.	HttpUrl : "https://sae.console.alibabacloud.com/cn-shenzhen/app-list/app1/micro-app/shell/pod1?tokenId=xxx
WebSocketUrl	string	O endereço do WebSocket.	wss://sae-webshell.console.aliyun.com/websocket/eamWebshell?tokenId=xxx&region=cn-shenzhen
ErrorCode	string	O código de erro retornado se a chamada falhar. Valores válidos: Se a solicitação for bem-sucedida, ErrorCode não será retornado. Se a solicitação falhar, o parâmetro ErrorCode será retornado. Para obter mais informações, consulte a seção Códigos de erro neste tópico.
Code	string	O código de status HTTP. Valores válidos: 2xx: A solicitação foi bem-sucedida. 3xx: A solicitação foi redirecionada. 4xx: A solicitação falhou. 5xx: Ocorreu um erro de servidor.	200
Success	boolean	Indica se a solicitação foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Token": "zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7",
    "HttpUrl": "HttpUrl :  \"https://sae.console.alibabacloud.com/cn-shenzhen/app-list/app1/micro-app/shell/pod1?tokenId=xxx",
    "WebSocketUrl": "wss://sae-webshell.console.aliyun.com/websocket/eamWebshell?tokenId=xxx&region=cn-shenzhen"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidApplication.NotFound	The current application does not exist.
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s
500	OperationFailed.RPCError	Internal RPC request processing error.	Internal RPC request processing error.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.