GetPlugins - - Centre de documentation Alibaba Cloud

Obtient les plugins de la place de marché des plugins.

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.

mse:GetPlugins

get

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GatewayUniqueId	string	Oui	L'identifiant unique de la passerelle.	gw-0adf3ad751284cc69fcf9669fba*****
Category	integer	Non	La catégorie du plugin. Valeurs valides : 0 : défini par l'utilisateur 1 : authentification et autorisation 2 : protection de sécurité 3 : protocole de transport 4 : contrôle du trafic 5 : surveillance du trafic	1
EnableOnly	boolean	Non	Si la valeur est true, renvoie uniquement les plugins activés.	true
Name	string	Non	Le nom du plugin.	key-auth
AcceptLanguage	string	Non	La langue de la réponse. Valeurs valides : zh (chinois) et en (anglais).	zh

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de réponse.
RequestId	string	L'identifiant de la requête.	03A3E2F4-6804-5663-9D5D-2EC47A1*****
Success	boolean	Indique si l'opération a réussi.	true
Code	integer	Le code de réponse.	200
ErrorCode	string	Le code d'erreur.	500
HttpStatusCode	integer	Le code d'état HTTP.	200
Message	string	Le message de réponse.	success
DynamicCode	string	L'espace réservé dans le message d'erreur dynamique.	code
DynamicMessage	string	Le message d'erreur dynamique.	message
Data	array<object>	Une liste de plugins.
	object	Les détails du plugin.
Id	integer	L'identifiant du plugin.	1
PrimaryUser	string	L'identifiant du créateur.	123
Category	integer	La catégorie du plugin. Valeurs valides : 0 : défini par l'utilisateur 1 : authentification et autorisation 2 : protection de sécurité 3 : protocole de transport 4 : contrôle du trafic 5 : surveillance du trafic	0
Name	string	Le nom du plugin.	key-auth
Version	string	La version du plugin.	v1
Summary	string	Le résumé du plugin.	Il s'agit d'un plugin
SummaryEn	string	Le résumé en anglais.
Phase	integer	La phase d'exécution du plugin. Valeurs valides : 0 : phase par défaut 1 : phase d'authentification 2 : phase d'autorisation 3 : phase de statistiques	1
Priority	integer	La priorité d'exécution du plugin. Une valeur plus élevée indique une priorité plus haute.	1
ConfigCheck	string	Le schéma de validation de la configuration.	# Validation des champs obligatoires de la configuration. Comme le montre l'exemple ci-dessous, la configuration du plugin doit obligatoirement contenir les champs "name", "age" et "friends". name: John age: 18 friends: - David - Anne
WasmLang	integer	Le langage dans lequel le plugin Wasm est implémenté. Valeurs valides : 0 : C++ 1 : TinyGo 2 : Rust 3 : AssemblyScript 4 : Zig	0
PublishState	integer	L'état de publication. Valeurs valides : 0 : Réussi 1 : En cours de publication 2 : Échoué	1
WasmFile	string	L'URL OSS du plugin Wasm.	https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515****/gw-0adf3ad751284cc69fcf9669fba*/2022/11/02/4d390496-2c17-4b42-a479-f9068ba/16673573*5.wasm
Status	string	L'état du plugin. Valeurs valides : 0 : désactivé 1 : activé	1
Mode	integer	Le type de plugin. Valeurs valides : 0 : plugin Wasm 2 : plugin Lua	0
MaxVersion	string	La dernière version.	1.0.0
NewVersionPublishingFlag	boolean	Indique si la dernière version est en cours de publication.	false

Exemples

JSON format

{
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****\n",
  "Success": true,
  "Code": 200,
  "ErrorCode": "500",
  "HttpStatusCode": 200,
  "Message": "success",
  "DynamicCode": "code",
  "DynamicMessage": "message",
  "Data": [
    {
      "Id": 1,
      "PrimaryUser": "123",
      "Category": 0,
      "Name": "key-auth",
      "Version": "v1",
      "Summary": "This is a plugin.",
      "SummaryEn": "",
      "Phase": 1,
      "Priority": 1,
      "ConfigCheck": "# Validate required fields in configuration, as shown in the following example, the plugin configuration must contain \"name\", \"age\", \"friends\" fields\nname: John\nage: 18\nfriends:\n- David\n- Anne",
      "WasmLang": 0,
      "PublishState": 1,
      "WasmFile": "https://mse-shared-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/cfg/import/1917515******/gw-0adf3ad751284cc69fcf9669fba*****/2022/11/02/4d390496-2c17-4b42-a479-f9068ba****/16673573***5.wasm",
      "Status": "1",
      "Mode": 0,
      "MaxVersion": "1.0.0",
      "NewVersionPublishingFlag": false
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

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

Notes de version

Consultez Notes de version pour la liste complète.