GetGatewayRouteDetail - - Centre de documentation Alibaba Cloud

Consulte les détails d'une route de passerelle.

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

get

*Gateway

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RouteId	integer	Oui	L'identifiant de la route.	1050
GatewayUniqueId	string	Oui	L'identifiant unique de la passerelle.	gw-5d3a78a53ec947aa928212d671d400ac
AcceptLanguage	string	Non	Type de langue des informations renvoyées.	zh

Éléments de réponse

Élément	Type	Description	Exemple
	object	Structure de données.
RequestId	string	Identifiant de la requête.	FDF2D16C-5D28-5FAA-A56B-30BDE3559880
HttpStatusCode	integer	Code d'état HTTP.	200
Message	string	Message d'erreur.	Vous n'êtes pas autorisé à effectuer cette opération
Code	integer	Code d'état. Notez que 200 indique une réussite.	200
Success	boolean	Résultat de la requête, avec les valeurs suivantes : `true` : la requête a réussi. `false` : la requête a échoué.	true
Data	object	Données renvoyées.
Id	integer	ID.	1050
Name	string	Nom.	test
GatewayUniqueId	string	L'identifiant unique de la passerelle.	gw-7ea3da97b96543e19f6c597c****
GatewayId	integer	Identifiant de la passerelle.	1
DefaultServiceId	integer	Identifiant du service par défaut.	3
DefaultServiceName	string	Nom du service par défaut.	test
Status	integer	État de la route. Non publiée : 0 En cours de publication : 2 Publiée : 3 En cours de modification (mises à jour non publiées) : 4 En cours de dépublication : 5 Indisponible : 6	0
GmtCreate	string	Heure de création.	2022-01-07 18:07:57
GmtModified	string	Heure de la dernière modification.	2022-01-07T10:07:57.000+0000
RouteOrder	integer	Ordre de la route.	1
Predicates	string	Conditions de correspondance.	{}
RoutePredicates	object	Correspondance de route.
PathPredicates	object	Route matching.
Path	string	Path.	/api
Type	string	Matching type.	PRE
IgnoreCase	boolean	Whether to ignore case.	true
MethodPredicates	array	Method matching.
	string	Method.	GET
HeaderPredicates	array<object>	Header matching.
	object	Request header.
Key	string	Request header KEY.	id
Value	string	Matching value.	200
Type	string	Type.	PRE
QueryPredicates	array<object>	Parameter matching.
	object	Parameter.
Key	string	Parameter name.	userid
Value	string	Matching value.	test
Type	string	Type.	PRE
DomainId	integer	Identifiant du domaine.	235
DomainName	string	Nom de domaine.	123.com
Services	string	Informations de configuration du service.	[{\"Percent\":100,\"ServiceId\":126}]
RouteServices	array<object>	Services.
	array<object>	Service.
ServiceId	integer	Service ID.	782
ServiceName	string	Service name.	xkc-crm
Percent	integer	Weight.	80
Version	string	Service version.	v1
Name	string	Service name.	dubbo4
SourceType	string	Service source.	MSE
Namespace	string	Namespace.	acs_ecs_dashboard
GroupName	string	Service group name.	api
AgreementType	string	Protocol Type.	DUBBO
HttpDubboTranscoder	object	Dubbo protocol conversion body.
DubboServiceName	string	Dubbo service name.	org.apache.dubbo.samples.basic.api.DemoService
DubboServiceVersion	string	Dubbo service version.	0.0.0
MothedMapList	array<object>	Dubbo forwarding rule list.
	array<object>
DubboMothedName	string	Dubbo method name.	sayHello
HttpMothed	string	Http method. Remarque Supported http method parameter values. ALL_GET ALL_POST ALL_PUT ALL_DELETE ALL_PATCH	ALL_GET
Mothedpath	string	Method matching path.	/mytestzbk/sayhello
PassThroughAllHeaders	string	Header pass-through type. Remarque Pass-through type enumeration values. Pass through all: PASS_ALL No pass-through: PASS_NOT Specified parameters: PASS_ASSIGN	PASS_NOT
PassThroughList	array	Specified Header pass-through list.
	string	Specified Header pass-through value.	x-forward
ParamMapsList	array<object>	Parameter mapping list.
	object
ExtractKeySpec	string	Input parameter position. Remarque Input parameter position enumeration values. Request parameter: `ALL_QUERY_PARAMETER` Request header: `ALL_HEADER` URI of the request: `ALL_PATH` Request body: `ALL_BODY`	ALL_QUERY_PARAMETER
ExtractKey	string	Input parameter extraction Key.	name
MappingType	string	Backend parameter type.	java.lang.String
DubboServiceGroup	string	Dubbo service group.	service group
ServicePort	integer	Service port.	20880
HealthStatus	string	Health status Health Unhealthy Checking Unknown	Health
UnhealthyEndpoints	array	Unhealthy Endpoint list
	string	Unhealthy Endpoint	192.168.1.2
HTTPRewrite	object	Informations sur la stratégie de réécriture.
Status	string	Enabling status.	off
Path	string	Node path.	/test/client
Host	string	Instance address.	aliyuncs.com
PathType	string	Rewrite type.	PRE
Pattern	string	Matching Pattern.	/test
Substitution	string	Replacement.	test
HeaderOp	object	Informations sur les paramètres d'en-tête.
Status	string	Status.	off
HeaderOpItems	array<object>	Header field objects.
	object	Setting policy.
DirectionType	string	Request or response.	Response
OpType	string	Operation type.	Add
Key	string	Header Key.	debug
Value	string	Setting value.	test
DestinationType	string	Type de service cible.	Single
DirectResponse	object	Informations de simulation.
Code	integer	Response code.	200
Body	string	Mock return value.	{}
Cors	object	Configuration interdomaine.
Status	string	Status.	off
AllowOrigins	string	Cross-domain.	*
AllowMethods	string	Cross-domain methods.	GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH
AllowHeaders	string	Cross-domain Header.	*
ExposeHeaders	string	Response header.	*
TimeUnit	string	Time unit.	h
UnitNum	integer	Time number.	24
AllowCredentials	boolean	Allow credentials.	true
Timeout	object	Configuration du délai d'expiration.
UnitNum	integer	Unit number.	10
TimeUnit	string	Time unit.	s
Status	string	Status.	off
Retry	object	Configuration des nouvelles tentatives.
Attempts	integer	Number of retry attempts.	1
RetryOn	array	Retry conditions.
	string	Retry condition.	5xx
HttpCodes	array	HTTP status codes.
	string	HTTP status code.	500
Status	string	Retry status.	on
DomainIdList	array	Liste des domaines.
	integer	Liste des identifiants de domaine.	1
DomainNameList	array	Liste des noms de domaine.
	string	Liste des noms de domaine.	test.com
Redirect	object	La configuration de la redirection.
Code	integer	Response code.	200
Host	string	Host.	16
Path	string	Path.	10111
FlowMirror	object	La configuration de la mise en miroir du trafic.
TargetServiceId	integer	Target service ID.	21
TargetServiceName	string	Target service name.	test
Port	integer	Target service port.	8790
Percentage	integer	Traffic replication percentage (%), value range 0-100.	90
Status	string	Enabling status, values: on: enabled off: disabled	on
EnableWaf	boolean	Indique si WAF doit être activé.	true
AhasStatus	integer	L'état d'Ahas.	1
Fallback	boolean	Indique si le service de repli doit être activé.	true
FallbackServices	array<object>	Les services de repli.
	object	L'objet de données.
ServiceId	integer	Service ID.	1
ServiceName	string	Service name.	name
Percent	integer	Weight percentage.	80
Version	string	Service version.	v1
Name	string	Name.	name
SourceType	string	Source type.	MSE
Namespace	string	Service namespace.	namespace
GroupName	string	Service group name.	test
AgreementType	string	Protocol Type.	DUBBO
ServicePort	integer	Service port.	8848
Policies	string	La chaîne JSON de la stratégie de routage.	{
Description	string	La description de la route.	une route pour xxx

Exemples

JSON format

{
  "RequestId": "FDF2D16C-5D28-5FAA-A56B-30BDE3559880",
  "HttpStatusCode": 200,
  "Message": "You are not authorized to perform this operation.",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 1050,
    "Name": "test",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597c****",
    "GatewayId": 1,
    "DefaultServiceId": 3,
    "DefaultServiceName": "test",
    "Status": 0,
    "GmtCreate": "2022-01-07 18:07:57",
    "GmtModified": "2022-01-07T10:07:57.000+0000",
    "RouteOrder": 1,
    "Predicates": "{}",
    "RoutePredicates": {
      "PathPredicates": {
        "Path": "/api",
        "Type": "PRE",
        "IgnoreCase": true
      },
      "MethodPredicates": [
        "GET"
      ],
      "HeaderPredicates": [
        {
          "Key": "id",
          "Value": "200",
          "Type": "PRE"
        }
      ],
      "QueryPredicates": [
        {
          "Key": "userid",
          "Value": "test",
          "Type": "PRE"
        }
      ]
    },
    "DomainId": 235,
    "DomainName": "123.com",
    "Services": "[{\\\"Percent\\\":100,\\\"ServiceId\\\":126}]",
    "RouteServices": [
      {
        "ServiceId": 782,
        "ServiceName": "xkc-crm",
        "Percent": 80,
        "Version": "v1",
        "Name": "dubbo4",
        "SourceType": "MSE",
        "Namespace": "acs_ecs_dashboard",
        "GroupName": "api",
        "AgreementType": "DUBBO",
        "HttpDubboTranscoder": {
          "DubboServiceName": "org.apache.dubbo.samples.basic.api.DemoService\n",
          "DubboServiceVersion": "0.0.0",
          "MothedMapList": [
            {
              "DubboMothedName": "sayHello",
              "HttpMothed": "ALL_GET",
              "Mothedpath": "/mytestzbk/sayhello",
              "PassThroughAllHeaders": "PASS_NOT",
              "PassThroughList": [
                "x-forward"
              ],
              "ParamMapsList": [
                {
                  "ExtractKeySpec": "ALL_QUERY_PARAMETER",
                  "ExtractKey": "name",
                  "MappingType": "java.lang.String"
                }
              ]
            }
          ],
          "DubboServiceGroup": "service group"
        },
        "ServicePort": 20880,
        "HealthStatus": "Health",
        "UnhealthyEndpoints": [
          "192.168.1.2"
        ]
      }
    ],
    "HTTPRewrite": {
      "Status": "off",
      "Path": "/test/client",
      "Host": "aliyuncs.com",
      "PathType": "PRE",
      "Pattern": "/test",
      "Substitution": "test"
    },
    "HeaderOp": {
      "Status": "off",
      "HeaderOpItems": [
        {
          "DirectionType": "Response",
          "OpType": "Add",
          "Key": "debug",
          "Value": "test"
        }
      ]
    },
    "DestinationType": "Single",
    "DirectResponse": {
      "Code": 200,
      "Body": "{}"
    },
    "Cors": {
      "Status": "off",
      "AllowOrigins": "*",
      "AllowMethods": "GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH",
      "AllowHeaders": "*",
      "ExposeHeaders": "*",
      "TimeUnit": "h",
      "UnitNum": 24,
      "AllowCredentials": true
    },
    "Timeout": {
      "UnitNum": 10,
      "TimeUnit": "s",
      "Status": "off"
    },
    "Retry": {
      "Attempts": 1,
      "RetryOn": [
        "5xx"
      ],
      "HttpCodes": [
        "500"
      ],
      "Status": "on"
    },
    "DomainIdList": [
      1
    ],
    "DomainNameList": [
      "test.com"
    ],
    "Redirect": {
      "Code": 200,
      "Host": "16",
      "Path": "10111"
    },
    "FlowMirror": {
      "TargetServiceId": 21,
      "TargetServiceName": "test",
      "Port": 8790,
      "Percentage": 90,
      "Status": "on"
    },
    "EnableWaf": true,
    "AhasStatus": 1,
    "Fallback": true,
    "FallbackServices": [
      {
        "ServiceId": 1,
        "ServiceName": "name",
        "Percent": 80,
        "Version": "v1",
        "Name": "name",
        "SourceType": "MSE",
        "Namespace": "namespace",
        "GroupName": "test",
        "AgreementType": "DUBBO",
        "ServicePort": 8848
      }
    ],
    "Policies": "{\n      \"CORS\": \"{\\\"allowMethods\\\":\\\"GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH\\\",\\\"allowHeaders\\\":\\\"*\\\",\\\"exposeHeaders\\\":\\\"*\\\",\\\"unitNum\\\":12,\\\"allowCredentials\\\":true,\\\"status\\\":\\\"off\\\",\\\"allowOrigins\\\":\\\"*\\\",\\\"timeUnit\\\":\\\"h\\\"}\",\n      \"Timeout\": \"{\\\"unitNum\\\":10,\\\"timeUnit\\\":\\\"s\\\",\\\"status\\\":\\\"off\\\"}\",\n      \"Retry\": \"{\\\"attempts\\\":2,\\\"retryOn\\\":[\\\"5xx\\\"],\\\"status\\\":\\\"off\\\"}\",\n      \"HTTPRewrite\": \"{\\\"pathType\\\":\\\"EQUAL\\\",\\\"path\\\":\\\"/o\\\",\\\"status\\\":\\\"off\\\"}\",\n      \"Waf\": \"{\\\"enabled\\\":false}\",\n      \"HeaderOp\": \"{\\\"status\\\":\\\"off\\\",\\\"headerOpItems\\\":[{\\\"directionType\\\":\\\"Request\\\",\\\"opType\\\":\\\"Add\\\",\\\"key\\\":\\\"kkk\\\",\\\"value\\\":\\\"ll\\\"}]}\"\n}",
    "Description": "a route for xxx"
  }
}

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.