DescribeSwimmingLane - Serverless App Engine: Central de Documentação do Alibaba Cloud

Obtém os detalhes de uma swimlane.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

sae:DescribeSwimmingLane

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /pop/v1/cas/gray/describeSwimmingLane HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NamespaceId	string	Não	O ID do namespace.	cn-beijing:test
GroupId	integer	Não	O ID do grupo de lanes.	2074
LaneId	integer	Não	O ID da swimming lane.	9637

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações retornadas.
RequestId	string	O ID da solicitação.	30375C38-F4ED-4135-A0AE-5C75DC7F****
Message	string	A mensagem retornada com a resposta. success é retornado se a solicitação for bem-sucedida. Um código de erro é retornado se a solicitação falhar.	success
TraceId	string	O ID de rastreamento. Você pode usar este ID para consultar os detalhes de uma chamada.	0a98a02315955564772843261e****
Data	object	Os dados retornados.
LaneId	integer	O ID da lane.	9488
LaneName	string	O nome da lane.	mse-test
LaneTag	string	A tag da lane.	{"alicloud.service.tag":"g1"}
Enable	boolean	Indica se a lane está ativada. `true`: ativada `false`: desativada	true
EnableRules	boolean	Indica se as regras de tráfego estão ativadas.	true
CanaryModel	integer	O modo para o canary release de ponta a ponta. Valores válidos: `0`: roteamento baseado em conteúdo `1`: roteamento baseado em porcentagem	0
Apps	array<object>	Uma lista de aplicações associadas.
	object	Uma aplicação associada à lane.
AppId	string	The ID of the application.	6b4c0f64-f679-4580-8105-91eac4******
AppName	string	The name of the application.	test
MseAppId	string	The ID of the MSE instance.	mse-cn-53y49******
MseAppName	string	The name of the MSE instance.	sae-test
mseNamespaceId	string	The ID of the MSE namespace.	6733e538-d52f-48e6-91a4-192f91******
AppEntryRule	object	A regra de entrada da aplicação.
Paths	array	The request paths.
	string	A request path.	/Path
Percentage	integer	The traffic percentage for percentage-based routing. Valid values: 0 to 100.	50
ConditionJoiner	string	The logical operator that joins conditions. Valid values: `AND`: All conditions must be met. `OR`: At least one of the conditions must be met.	AND
Conditions	array<object>	The match conditions.
	object	A match condition.
Type	string	The type of the parameter.	Header
Name	string	The name of the parameter.	t
Condition	string	The match operator.	==
Value	string	The value to match.	g1
Values	array	The values to match.
	string	A value to match.	g1
IndependentPercentageEnable	boolean	Indicates whether percentage-based canary release is enabled.	true
PercentageByPath	object	An object that maps paths to traffic percentages.
	integer	The traffic percentage.	100
MseGatewayEntryRule	object	A regra de entrada para o MSE Gateway.
RouteIds	array	A list of route IDs.
	integer	A route ID.	["1001","1002"]
Routes	array<object>	The route configurations.
	array<object>	A route configuration.
RouteId	integer	The route ID.	9504
RouteName	string	The name of the route.	demo
RoutePredicate	object	The route predicate.
PathPredicate	object	The path-based match rule.
Path	string	The path.	/Path
Type	string	The match type.	Header
Percentage	integer	The traffic percentage for the rule.	100
Conditions	array<object>	The match conditions.
	object	A match condition.
Type	string	The type of the parameter.	Header
Name	string	The name of the parameter.	t
Condition	string	The match operator.	==
Value	string	The value to match.	g1
PercentageByRoute	object	An object that maps route IDs to traffic percentages.
	integer	The traffic percentage. Valid values: 1 to 100.	100
IndependentPercentageEnable	boolean	Indicates whether percentage-based canary release is enabled.	true
ConditionJoiner	string	The logical operator that joins conditions.	AND
ErrorCode	string	O código de erro. Este parâmetro é retornado apenas se a solicitação falhar. Para mais informações, consulte a seção Códigos de erro neste tópico.
Code	string	O código de status HTTP retornado. 2xx: Sucesso. 3xx: Redirecionamento. 4xx: Erro do cliente. 5xx: Erro do servidor.	200
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A consulta foi bem-sucedida. false: A consulta falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "30375C38-F4ED-4135-A0AE-5C75DC7F****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "LaneId": 9488,
    "LaneName": "mse-test",
    "LaneTag": "{\"alicloud.service.tag\":\"g1\"}",
    "Enable": true,
    "EnableRules": true,
    "CanaryModel": 0,
    "Apps": [
      {
        "AppId": "6b4c0f64-f679-4580-8105-91eac4******",
        "AppName": "test",
        "MseAppId": "mse-cn-53y49******",
        "MseAppName": "sae-test",
        "mseNamespaceId": "6733e538-d52f-48e6-91a4-192f91******"
      }
    ],
    "AppEntryRule": {
      "Paths": [
        "/Path"
      ],
      "Percentage": 50,
      "ConditionJoiner": "AND",
      "Conditions": [
        {
          "Type": "Header",
          "Name": "t",
          "Condition": "==",
          "Value": "g1",
          "Values": [
            "g1"
          ]
        }
      ],
      "IndependentPercentageEnable": true,
      "PercentageByPath": {
        "key": 100
      }
    },
    "MseGatewayEntryRule": {
      "RouteIds": [
        0
      ],
      "Routes": [
        {
          "RouteId": 9504,
          "RouteName": "demo\n",
          "RoutePredicate": {
            "PathPredicate": {
              "Path": "/Path",
              "Type": "Header"
            }
          }
        }
      ],
      "Percentage": 100,
      "Conditions": [
        {
          "Type": "Header",
          "Name": "t",
          "Condition": "==",
          "Value": "g1"
        }
      ],
      "PercentageByRoute": {
        "key": 100
      },
      "IndependentPercentageEnable": true,
      "ConditionJoiner": "AND"
    }
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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
400	MseGatewayRule.CreateFailed	Create MSE Gateway rule failed.	Failed to create an MSE microservices gateway route.
400	InternalApiError	An exception occurred when calling mse:%s, error message: %s.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.