GetWebshellToken - Serverless App Engine - Centro de documentación de Alibaba Cloud

Obtiene el token utilizado para iniciar sesión de forma remota en la Webshell de una instancia.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

sae:GetWebshellToken

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

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

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
AppId	string	Sí	El ID de la aplicación de mensajería interactiva.	017f39b8-dfa4-4e16-a84b-1dcee4b1****
PodName	string	Sí	El nombre del pod.	hello-podsdfsdfsdfsdf
ContainerName	string	No	El nombre del contenedor de inicialización. Nota: Si especifica este parámetro, Cloud Assistant ejecuta el comando en el contenedor especificado de las instancias. Si se especifica este parámetro, el comando solo puede ejecutarse en instancias Linux que tengan instalado Cloud Assistant Agent versión 2.2.3.344 o posterior. Para obtener información sobre cómo consultar la versión de Cloud Assistant Agent, consulte Instalar Cloud Assistant Agent. Para obtener información sobre cómo actualizar Cloud Assistant Agent, consulte Actualizar o deshabilitar actualizaciones de Cloud Assistant Agent. Si se especifica este parámetro, el parámetro `Username` indicado en una solicitud para llamar a esta operación y el parámetro `WorkingDir` indicado en una solicitud para llamar a la operación CreateCommand no surten efecto. Solo puede ejecutar el comando en el directorio de trabajo predeterminado del contenedor mediante el usuario predeterminado del contenedor. Para obtener más información, consulte Usar Cloud Assistant para ejecutar comandos en contenedores. Si se especifica este parámetro, solo se pueden ejecutar scripts de shell en contenedores Linux. No puede agregar un comando con un formato similar a `#!/usr/bin/python` al inicio de un script para especificar un intérprete de scripts. Para obtener más información, consulte Usar Cloud Assistant para ejecutar comandos en contenedores.	ad-helper

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	El mensaje devuelto. Descripción del valor: Si la solicitud fue exitosa, se devuelve un mensaje de éxito. Se devuelve un código de error si la solicitud falló.	success
TraceId	string	El ID de la traza.	0a98a02315955564772843261e****
Data	object	El resultado devuelto.
Token	string	La información sobre el token.	zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7
HttpUrl	string	La dirección de la página de Webshell.	HttpUrl : "https://sae.console.alibabacloud.com/cn-shenzhen/app-list/app1/micro-app/shell/pod1?tokenId=xxx
WebSocketUrl	string	La dirección de WebSocket.	wss://sae-webshell.console.alibabacloud.com/websocket/eamWebshell?tokenId=xxx&region=cn-shenzhen
ErrorCode	string	El código de error devuelto si la llamada falló. Valores válidos: Si la solicitud fue exitosa, no se devuelve ErrorCode. Si la solicitud falló, se devuelve el parámetro ErrorCode. Para obtener más información, consulte la sección Códigos de error en este tema.
Code	string	El código de estado HTTP. Valores válidos: 2xx: La solicitud fue exitosa. 3xx: La solicitud fue redirigida. 4xx: La solicitud falló. 5xx: Ocurrió un error del servidor.	200
Success	boolean	Indica si la solicitud fue exitosa.	true

Ejemplos

Respuesta exitosa

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.alibabacloud.com/websocket/eamWebshell?tokenId=xxx&region=cn-shenzhen"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
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 error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.