GetWebshellToken - - Centre de documentation Alibaba Cloud

Obtient le jeton utilisé pour se connecter à distance au Webshell d'une instance.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

sae:GetWebshellToken

get

*All Resource

*

Aucune

Syntaxe de la requête

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

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AppId	string	Oui	L'identifiant de l'application de messagerie interactive.	017f39b8-dfa4-4e16-a84b-1dcee4b1****
PodName	string	Oui	Le nom du pod.	hello-podsdfsdfsdfsdf
ContainerName	string	Non	Le nom du conteneur d'initialisation. Remarque : Si vous spécifiez ce paramètre, Cloud Assistant exécute la commande dans le conteneur spécifié des instances. Si ce paramètre est spécifié, la commande ne peut s'exécuter que sur des instances Linux sur lesquelles l'agent Cloud Assistant version 2.2.3.344 ou ultérieure est installé. Pour plus d'informations sur la façon de consulter la version de l'agent Cloud Assistant, consultez Installer l'agent Cloud Assistant. Pour plus d'informations sur la façon de mettre à niveau l'agent Cloud Assistant, consultez Mettre à niveau ou désactiver les mises à niveau de l'agent Cloud Assistant. Si ce paramètre est spécifié, le paramètre Username spécifié dans une requête appelant cette opération et le paramètre WorkingDir spécifié dans une requête appelant l'opération CreateCommand ne prennent pas effet. Vous pouvez exécuter la commande uniquement dans le répertoire de travail par défaut du conteneur en utilisant l'utilisateur par défaut du conteneur. Pour plus d'informations, consultez Utiliser Cloud Assistant pour exécuter des commandes dans des conteneurs. Si ce paramètre est spécifié, seuls les scripts shell peuvent être exécutés dans les conteneurs Linux. Vous ne pouvez pas ajouter une commande au format similaire à #!/usr/bin/python au début d'un script pour spécifier un interpréteur de script. Pour plus d'informations, consultez Utiliser Cloud Assistant pour exécuter des commandes dans des conteneurs.	ad-helper

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	Le message renvoyé. Description des valeurs : Si la requête a réussi, un message de réussite est renvoyé. Un code d'erreur est renvoyé si la requête a échoué.	success
TraceId	string	L'identifiant de la trace.	0a98a02315955564772843261e****
Data	object	Le résultat renvoyé.
Token	string	Les informations relatives au jeton.	zWWpvRj_5pzof4hfo7-hGynM8oGMmO_7
HttpUrl	string	L'adresse de la page Webshell.	HttpUrl : "https://sae.console.alibabacloud.com/cn-shenzhen/app-list/app1/micro-app/shell/pod1?tokenId=xxx
WebSocketUrl	string	L'adresse WebSocket.	wss://sae-webshell.console.aliyun.com/websocket/eamWebshell?tokenId=xxx&region=cn-shenzhen
ErrorCode	string	Le code d'erreur renvoyé si l'appel a échoué. Valeurs valides : Si la requête a réussi, ErrorCode n'est pas renvoyé. Si la requête a échoué, le paramètre ErrorCode est renvoyé. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.
Code	string	Le code d'état HTTP. Valeurs valides : 2xx : la requête a réussi. 3xx : la requête a été redirigée. 4xx : la requête a échoué. 5xx : une erreur de serveur s'est produite.	200
Success	boolean	Indique si la requête a réussi.	true

Exemples

JSON format

{
  "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
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
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.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.