DescribeCenRouteMaps - Cloud Enterprise Network: Central de Documentação do Alibaba Cloud

Você pode chamar a operação DescribeCenRouteMaps para consultar as configurações de políticas de roteamento.

Descrição da operação

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

cen:DescribeCenRouteMaps

get

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valor padrão: 10.	10
CenId	string	Sim	O ID da instância do Cloud Enterprise Network (CEN).	cen-wx12mmlt17ld82****
RouteMapId	string	Não	O ID da política de roteamento.	cenrmap-y40mxdvf7joc12****
CenRegionId	string	Não	O ID da região onde a política de roteamento é aplicada. Você pode chamar a operação DescribeChildInstanceRegions para consultar IDs de região.	cn-hangzhou
TransmitDirection	string	Não	A direção na qual a política de roteamento é aplicada. Valores válidos: RegionIn: Entrada. A política de roteamento é aplicada a rotas que são anunciadas ao gateway de uma região. Por exemplo, rotas são anunciadas de instâncias de rede na região atual para o gateway da região atual, ou rotas de outras regiões são anunciadas para o gateway da região atual. RegionOut: Saída. A política de roteamento é aplicada a rotas que são anunciadas a partir do gateway de uma região. Por exemplo, rotas são anunciadas do gateway da região atual para instâncias de rede na região atual, ou para gateways em outras regiões.	RegionOut
TransitRouterRouteTableId	string	Não	O ID da tabela de rotas do transit router associada à política de roteamento.	vtb-gw8nx3515m1mbd1z1****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
PageSize	integer	O número de entradas retornadas por página.	10
RequestId	string	O ID da solicitação.	24CE1987-D1D1-5324-9BAD-2750B60E6ABB
PageNumber	integer	O número da página.	1
TotalCount	integer	O número total de entradas retornadas.	1
RouteMaps	object
RouteMap	array<object>	Uma lista de políticas de roteamento.
	array<object>	As informações sobre a política de roteamento.
RouteMapId	string	The ID of the routing policy.	cenrmap-y40mxdvf7joc12****
Status	string	The status of the routing policy. Creating: The routing policy is being created. Active: The routing policy is available. Deleting: The routing policy is being deleted.	Active
TransmitDirection	string	The direction in which the routing policy is applied.	RegionOut
SourceInstanceIdsReverseMatch	boolean	Indicates whether the source instance IDs are excluded. false: The match is successful if the source instance ID of the route is in the SourceInstanceIds.N list. true: The match is successful if the source instance ID of the route is not in the SourceInstanceIds.N list.	false
CenRegionId	string	The ID of the region where the routing policy is applied.	cn-hangzhou
CenId	string	The ID of the CEN instance.	cen-wx12mmlt17ld82****
Priority	integer	The priority of the routing policy. A smaller value indicates a higher priority.	5000
TransitRouterRouteTableId	string	The ID of the route table of the transit router that is associated with the routing policy.	vtb-gw8nx3515m1mbd1z1****
CommunityOperateMode	string	The action to be performed on the community. Additive: adds the community to the route. Replace: replaces the original community of the route. This parameter specifies the action to be performed after a route meets the match conditions.	Additive
MapResult	string	The action that is performed after all match conditions are met. Permit: allows the matched route. Deny: denies the matched route.	Deny
CommunityMatchMode	string	The match mode for the community. Include: fuzzy match. The match is successful if the community of the route overlaps with the community in the match condition. Complete: exact match. The match is successful only if the community of the route is the same as the community in the match condition.	Include
Description	string	The description of the routing policy.	desctest
AsPathMatchMode	string	The match mode for the AS-path. Include: fuzzy match. The match is successful if the AS-path of the route overlaps with the AS-path in the match condition. Complete: exact match. The match is successful only if the AS-path of the route is the same as the AS-path in the match condition.	Include
Preference	integer	The new priority of the route. A smaller value indicates a higher priority. This parameter specifies the action to be performed after a route meets the match conditions.	20
DestinationInstanceIdsReverseMatch	boolean	Indicates whether the destination instance IDs are excluded. false: The match is successful if the destination instance ID of the route is in the DestinationInstanceIds.N list. true: The match is successful if the destination instance ID of the route is not in the DestinationInstanceIds.N list.	false
CidrMatchMode	string	The match mode for the prefix list. Valid values: Include: fuzzy match. The match is successful if the route prefix in the match condition includes the route prefix of the route. For example, a policy with the 10.10.0.0/16 route prefix matches the 10.10.1.0/24 route. Complete: exact match. The match is successful only if the route prefix in the match condition is the same as the route prefix of the route. For example, a policy with the 10.10.0.0/16 route prefix matches only the 10.10.0.0/16 route.	Include
NextPriority	integer	The priority of the next routing policy that is associated with the current routing policy.	33
MatchAddressType	string	The IP address family of the route. IPv4: matches only IPv4 routes. IPv6: matches only IPv6 routes. If this parameter is not returned, both IPv4 and IPv6 routes are matched.	IPv4
SourceRegionIds	object
SourceRegionId	array	A list of source region IDs to be matched.
	string	A list of source region IDs to be matched.	cn-hangzhou
SourceChildInstanceTypes	object
SourceChildInstanceType	array	A list of source instance types to be matched. VPC: virtual private cloud (VPC). VBR: virtual border router (VBR). CCN: Cloud Connect Network (CCN). VPN: IPsec connection.
	string	A list of source instance types to be matched. VPC: VPC. VBR: VBR. CCN: CCN. VPN: IPsec connection.	VPC
DestinationRouteTableIds	object
DestinationRouteTableId	array	A list of destination route table IDs to be matched. You can enter up to 32 route table IDs. Nota This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination route table belongs to a network instance in the current region.
	string	A list of destination route table IDs to be matched. You can enter up to 32 route table IDs. Nota This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination route table belongs to a network instance in the current region.	vtb-adefrgtr144vf****
SourceInstanceIds	object
SourceInstanceId	array	A list of source instance IDs to be matched.
	string	A list of source instance IDs to be matched.	vpc-adeg3544fdf34vf****
DestinationCidrBlocks	object
DestinationCidrBlock	array	A list of prefixes to be matched. Both IPv4 and IPv6 prefixes are supported.
	string	A list of prefixes to be matched. Both IPv4 and IPv6 prefixes are supported.	10.10.10.0/24
DestinationRegionIds	object
DestinationRegionId	array	A list of destination region IDs.
	string	A list of destination region IDs.	cn-beijing
SourceRouteTableIds	object
SourceRouteTableId	array	A list of source route table IDs to be matched.
	string	A list of source route table IDs to be matched.	vtb-adfr233vf34rvd4****
MatchCommunitySet	object
MatchCommunity	array	The community to be matched.
	string	The community to be matched.	65501:1
PrependAsPath	object
AsPath	array	The AS-path that is prepended when the regional gateway receives or advertises a route. This parameter specifies the action to be performed after a route meets the match conditions.
	string	The AS-path that is prepended when the regional gateway receives or advertises a route. This parameter specifies the action to be performed after a route meets the match conditions.	65501
RouteTypes	object
RouteType	array	A list of route types to be matched. System: system routes that are automatically generated by the system. Custom: custom routes that are manually added. BGP: routes that are advertised through Border Gateway Protocol (BGP).
	string	A list of route types to be matched. System: system routes that are automatically generated by the system. Custom: custom routes that are manually added. BGP: routes that are advertised through BGP.	System
DestinationChildInstanceTypes	object
DestinationChildInstanceType	array	A list of destination instance types to be matched. VPC: VPC. VBR: VBR. CCN: CCN. VPN: IPsec connection. Nota This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination instance is in the current region.
	string	A list of destination instance types to be matched. VPC: VPC. VBR: VBR. CCN: CCN. VPN: IPsec connection. Nota This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination instance is in the current region.	VPC
DestinationInstanceIds	object
DestinationInstanceId	array	A list of destination instance IDs to be matched. Nota This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination instance is in the current region.
	string	A list of destination instance IDs to be matched. Nota This parameter takes effect only when the routing policy is applied to the outbound direction of the regional gateway and the destination instance is in the current region.	vpc-afrfs434465fdf****
MatchAsns	object
MatchAsn	array	A list of AS-paths to be matched.
	string	A list of AS-paths to be matched.	65501
OperateCommunitySet	object
OperateCommunity	array	The community to be operated.
	string	The community to be operated.	65501:1

Exemplos

Resposta de sucesso

JSON formato

{
  "PageSize": 10,
  "RequestId": "24CE1987-D1D1-5324-9BAD-2750B60E6ABB",
  "PageNumber": 1,
  "TotalCount": 1,
  "RouteMaps": {
    "RouteMap": [
      {
        "RouteMapId": "cenrmap-y40mxdvf7joc12****",
        "Status": "Active",
        "TransmitDirection": "RegionOut",
        "SourceInstanceIdsReverseMatch": false,
        "CenRegionId": "cn-hangzhou",
        "CenId": "cen-wx12mmlt17ld82****",
        "Priority": 5000,
        "TransitRouterRouteTableId": "vtb-gw8nx3515m1mbd1z1****",
        "CommunityOperateMode": "Additive",
        "MapResult": "Deny",
        "CommunityMatchMode": "Include",
        "Description": "desctest",
        "AsPathMatchMode": "Include",
        "Preference": 20,
        "DestinationInstanceIdsReverseMatch": false,
        "CidrMatchMode": "Include",
        "NextPriority": 33,
        "MatchAddressType": "IPv4",
        "SourceRegionIds": {
          "SourceRegionId": [
            "cn-hangzhou"
          ]
        },
        "SourceChildInstanceTypes": {
          "SourceChildInstanceType": [
            "VPC"
          ]
        },
        "DestinationRouteTableIds": {
          "DestinationRouteTableId": [
            "vtb-adefrgtr144vf****"
          ]
        },
        "SourceInstanceIds": {
          "SourceInstanceId": [
            "vpc-adeg3544fdf34vf****"
          ]
        },
        "DestinationCidrBlocks": {
          "DestinationCidrBlock": [
            "10.10.10.0/24"
          ]
        },
        "DestinationRegionIds": {
          "DestinationRegionId": [
            "cn-beijing"
          ]
        },
        "SourceRouteTableIds": {
          "SourceRouteTableId": [
            "vtb-adfr233vf34rvd4****"
          ]
        },
        "MatchCommunitySet": {
          "MatchCommunity": [
            "65501:1"
          ]
        },
        "PrependAsPath": {
          "AsPath": [
            "65501"
          ]
        },
        "RouteTypes": {
          "RouteType": [
            "System"
          ]
        },
        "DestinationChildInstanceTypes": {
          "DestinationChildInstanceType": [
            "VPC"
          ]
        },
        "DestinationInstanceIds": {
          "DestinationInstanceId": [
            "vpc-afrfs434465fdf****"
          ]
        },
        "MatchAsns": {
          "MatchAsn": [
            "65501"
          ]
        },
        "OperateCommunitySet": {
          "OperateCommunity": [
            "65501:1"
          ]
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.