GetPluginConfig - - Centre de documentation Alibaba Cloud

Obtient la configuration du plug-in.

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:GetPluginConfig

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-ubuwqygbq4783gqb2y3f87q****
PluginId	integer	Oui	L'identifiant du plug-in de la passerelle.	123
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	RestResult.
RequestId	string	L'identifiant de la requête.	03A3E2F4-6804-5663-9D5D-2EC47A1*****
Success	boolean	Indique si la requête a réussi.	true
Code	integer	Le code d'état.	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	Le code d'erreur dynamique.	code
DynamicMessage	string	Le message d'erreur dynamique.	message
Data	object	Les données de réponse.
Id	integer	L'identifiant du plug-in.	1
PrimaryUser	string	L'identifiant du créateur.	123
Type	integer	Le type de plug-in. Valeurs valides : 0 : filtre HTTP 1 : filtre réseau	0
Category	integer	La catégorie du plug-in. Valeurs valides : 0 : Personnalisé 1 : Autorisation d'accès 2 : Protection de sécurité 3 : Protocole de transport 4 : Contrôle du trafic 5 : Observation du trafic	0
Name	string	Le nom du plug-in.	name
Version	string	La version du plug-in.	v1
Summary	string	Le résumé du plug-in.	Ceci est un plug-in
SummaryEn	string	Le résumé du plug-in en anglais.
Readme	string	Le contenu du README.	lisez-moi
ReadmeEn	string	Le contenu du README en anglais.	lisez-moi
ConfigExample	string	L'exemple de configuration du plug-in.
Phase	integer	La phase d'exécution du plug-in. Valeurs valides : 0 : Phase par défaut 1 : Phase d'authentification 2 : Phase d'autorisation 3 : Phase de statistiques	0
Priority	integer	La priorité d'exécution. Une valeur plus élevée indique une priorité plus élevée.	1
ConfigCheck	string	La vérification de la configuration.	# Validation des champs obligatoires de la configuration. Comme illustré dans l'exemple suivant, la configuration du plug-in doit inclure les champs "name", "age" et "friends" name: John age: 18 friends: - David - Anne
Mode	integer	Le mode.	0
WasmLang	integer	Le langage d'implémentation Wasm. Valeurs valides : 0 : C++ 1 : TinyGo 2 : Rust 3 : AssemblyScript 4 : Zig	0
ImageName	string	Le nom de l'image.	name
PublishState	integer	L'état de publication.	1
Status	string	L'état. Valeurs valides : 0 : Désactivé 1 : Activé	1
GatewayConfigList	array<object>	La liste des configurations du plug-in.
	array<object>	Une configuration de plug-in.
Id	integer	The plugin configuration ID.	1
GatewayId	integer	The gateway ID.	1
GatewayUniqueId	string	The unique ID of the gateway.	gw-ubuwqygbq4783gqb2y3f87q****
PluginId	integer	The gateway plugin ID.	1
Enable	boolean	Indicates whether the plugin configuration is enabled.	true
Config	string	The plugin configuration.	# Validate required fields in configuration, as shown in the following example, the plugin configuration must contain "name", "age", "friends" fields name: John age: 18 friends: - David - Anne
ConfigLevel	integer	The application scope of the plugin. Valid values: 0: Global 1: Domain 2: Route	0
ResourceList	array<object>	A list of resources, which can be domains or routes depending on the value of `ConfigLevel`.
	object
Id	integer	The resource ID.
Name	string	The name of the resource, which can be a domain or route name.	test-route
GmtCreate	string	The creation time.	1667309705000
GmtModified	string	The modification time.	1667309705000
RouteConfigStartIndex	integer	L'index de départ des règles au niveau de la route dans le tableau `GatewayConfigList`. Si aucune règle au niveau de la route n'existe, la valeur est -1.	0
DomainConfigStartIndex	integer	L'index de départ des règles au niveau du domaine dans le tableau `GatewayConfigList`. Si aucune règle au niveau du domaine n'existe, la valeur est -1.	5
GatewayConfigStartIndex	integer	L'index de la règle au niveau de l'instance dans le tableau `GatewayConfigList`. Si aucune règle au niveau de l'instance n'existe, la valeur est -1.	7
VersionJson	string	Une chaîne JSON qui représente une liste des versions du plug-in de la passerelle.	[{"id":1, "version": "1.0.0"}]

Exemples

JSON format

{
  "RequestId": "03A3E2F4-6804-5663-9D5D-2EC47A1*****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "500",
  "HttpStatusCode": 200,
  "Message": "success",
  "DynamicCode": "code",
  "DynamicMessage": "message",
  "Data": {
    "Id": 1,
    "PrimaryUser": "123",
    "Type": 0,
    "Category": 0,
    "Name": "name",
    "Version": "v1",
    "Summary": "This is a plugin.",
    "SummaryEn": "",
    "Readme": "read me",
    "ReadmeEn": "read me",
    "ConfigExample": "",
    "Phase": 0,
    "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",
    "Mode": 0,
    "WasmLang": 0,
    "ImageName": "name",
    "PublishState": 1,
    "Status": "1",
    "GatewayConfigList": [
      {
        "Id": 1,
        "GatewayId": 1,
        "GatewayUniqueId": "gw-ubuwqygbq4783gqb2y3f87q****",
        "PluginId": 1,
        "Enable": true,
        "Config": "# 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",
        "ConfigLevel": 0,
        "ResourceList": [
          {
            "Id": 0,
            "Name": "test-route"
          }
        ],
        "GmtCreate": "1667309705000",
        "GmtModified": "1667309705000"
      }
    ],
    "RouteConfigStartIndex": 0,
    "DomainConfigStartIndex": 5,
    "GatewayConfigStartIndex": 7,
    "VersionJson": "[{\"id\":1, \"version\": \"1.0.0\"}]"
  }
}

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.