Consulta os detalhes de uma ou mais regras de mapa de rotas.
Descrição da operação
Descrição da solicitação
RouteMapId: especifica o mapa de rotas ao qual pertencem as regras a serem consultadas.
RouteMapRuleIds: a lista de IDs de regras a serem consultadas. Este parâmetro e as condições de filtro podem ser usados juntos para correspondência, e a relação é OR.
Filter: as condições de filtro. Você pode filtrar por atributos como direção. As condições de filtro suportadas incluem Status e Direction.
DryRun: especifica se o modo dry run deve ser ativado. Valor padrão: false.
Você deve especificar pelo menos um entre RouteMapId e RouteMapRuleIds. Se ambos forem fornecidos, uma consulta conjunta será realizada com base nesses dois parâmetros. Se apenas RouteMapId for fornecido, todas as regras sob o mapa de rotas serão retornadas. Se apenas RouteMapRuleIds for fornecido, os detalhes dessas regras serão retornados.
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
cen:ListRouteMapRules |
list |
RouteMapRule
RouteMap
|
Nenhuma | Nenhuma |
Sintaxe da solicitação
GET / HTTP/1.1
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| ClientToken |
string |
Não |
O token de cliente usado para garantir a idempotência da solicitação. Você pode gerar um valor de parâmetro em seu cliente para garantir que o valor do parâmetro seja exclusivo em diferentes solicitações. O parâmetro ClientToken suporta apenas caracteres ASCII. Nota
Se você não especificar este parâmetro, o sistema usa automaticamente o RequestId da solicitação de API como o ClientToken. O RequestId de cada solicitação de API pode ser diferente. |
02fb3da4-130e-11e9-8e44-001**** |
| RouteMapId |
string |
Não |
O ID do mapa de rotas a ser consultado. |
rm-0a1b2c3d4e5f6a7b8 |
| RouteMapRuleIds |
array |
Não |
A lista de IDs de regras de mapa de rotas a serem consultadas. Este parâmetro e as condições de filtro podem ser usados juntos para correspondência, e a relação é AND. |
|
|
string |
Não |
A lista de IDs de regras de mapa de rotas a serem consultadas. Este parâmetro e as condições de filtro podem ser usados juntos para correspondência, e a relação é AND. |
rmr-0a1b2c3d4e5f6a7b8 |
|
| Filter |
array<object> |
Não |
As condições de filtro. Você pode especificar até 5 condições de filtro por vez. |
|
|
object |
Não |
As condições de filtro. Você pode especificar até 5 condições de filtro por vez. |
||
| Key |
string |
Não |
A condição de filtro. Valores válidos:
Por padrão, várias condições de filtro são avaliadas usando o operador lógico AND. Uma regra corresponde às condições de filtro apenas se atender a todas as condições de filtro. Você pode especificar até 5 condições de filtro por vez. |
Name |
| Value |
array |
Não |
O valor da condição de filtro. Especifique o valor do filtro com base na Key. Você pode especificar vários valores de filtro para uma única Key. Vários valores de filtro são avaliados usando o operador lógico OR. Uma regra corresponde à condição de filtro se atender a qualquer um dos valores de filtro. Você pode especificar até 5 valores de filtro para uma única condição de filtro. |
|
|
string |
Não |
O valor da condição de filtro. Especifique o valor do filtro com base na Key. Você pode especificar vários valores de filtro para uma única Key. Vários valores de filtro são avaliados usando o operador lógico OR. Uma regra corresponde à condição de filtro se atender a qualquer um dos valores de filtro. Você pode especificar até 5 valores de filtro para uma única condição de filtro. |
test |
|
| DryRun |
boolean |
Não |
Especifica se apenas a verificação prévia da solicitação deve ser realizada. Valores válidos:
|
|
| MaxResults |
integer |
Não |
O número de entradas a serem retornadas em cada página. |
20 |
| NextToken |
string |
Não |
O token usado para recuperar a próxima página de resultados. Valores válidos:
|
dd20**** |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
A resposta. |
||
| TotalCount |
integer |
O número total de entradas. |
2 |
| RequestId |
string |
O ID da solicitação. |
EF44D7B7-6248-5A60-8A4C-A92388605A57 |
| NextToken |
string |
O token usado para recuperar a próxima página de resultados. Valores válidos:
|
dd20**** |
| MaxResults |
integer |
O número de entradas retornadas em cada página. |
20 |
| RouteMapRules |
array<object> |
A lista de regras do mapa de rotas. |
|
|
array<object> |
As informações sobre a regra do mapa de rotas. |
||
| Description |
string |
A descrição da regra. |
Matches production prefixes from on-prem and sets a higher local preference. |
| MatchConditions |
object |
As condições de correspondência da regra do mapa de rotas. O sistema executa as ações definidas em SetActions apenas se uma rota atender a todas as condições de correspondência definidas neste parâmetro. |
|
| AddressPrefixesInclude |
array |
A lista de prefixos de roteamento para correspondência aproximada. Uma correspondência é bem-sucedida se o prefixo de rota na condição de correspondência contiver o prefixo de rota da rota correspondente. Por exemplo, uma política definida com 10.0.0.0/8 pode fazer uma correspondência aproximada com uma rota com 10.10.10.0/24. Os blocos CIDR de IP estão no formato CIDR e suportam IPv4 e IPv6. Este parâmetro e AddressPrefixesMatch são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. |
|
|
string |
A lista de prefixos de roteamento para correspondência aproximada. Uma correspondência é bem-sucedida se o prefixo de rota na condição de correspondência contiver o prefixo de rota da rota correspondente. Por exemplo, uma política definida com 10.0.0.0/8 pode fazer uma correspondência aproximada com uma rota com 10.10.10.0/24. Os blocos CIDR de IP estão no formato CIDR e suportam IPv4 e IPv6. Este parâmetro e AddressPrefixesMatch são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. |
10.0.0.0/8 |
|
| AddressPrefixesMatch |
array |
A lista de prefixos de roteamento para correspondência exata. Uma correspondência é bem-sucedida apenas se o prefixo de rota na condição de correspondência for exatamente igual ao prefixo de rota da rota correspondente. Por exemplo, uma política definida com 10.0.0.0/8 só pode fazer uma correspondência exata com uma rota com 10.0.0.0/8. Os blocos CIDR de IP estão no formato CIDR e suportam IPv4 e IPv6. Este parâmetro e AddressPrefixesInclude são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. |
|
|
string |
A lista de prefixos de roteamento para correspondência exata. Uma correspondência é bem-sucedida apenas se o prefixo de rota na condição de correspondência for exatamente igual ao prefixo de rota da rota correspondente. Por exemplo, uma política definida com 10.0.0.0/8 só pode fazer uma correspondência exata com uma rota com 10.0.0.0/8. Os blocos CIDR de IP estão no formato CIDR e suportam IPv4 e IPv6. Este parâmetro e AddressPrefixesInclude são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. |
10.0.0.0/8 |
|
| AsPathsInclude |
array |
A lista de caminhos AS para correspondência aproximada. Uma correspondência é bem-sucedida se o caminho AS na condição de correspondência se sobrepor ao caminho AS da rota correspondente. Este parâmetro e AsPathsMatch são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Nota
Apenas AS SEQUENCE é suportado. AS SET, AS CONFED SEQUENCE e AS CONFED SET não são suportados. Isso significa que apenas uma lista de números AS é suportada, e conjuntos e sublistas não são suportados. |
|
|
integer |
A lista de caminhos AS para correspondência aproximada. Uma correspondência é bem-sucedida se o caminho AS na condição de correspondência se sobrepor ao caminho AS da rota correspondente. Este parâmetro e AsPathsMatch são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Nota
Apenas AS SEQUENCE é suportado. AS SET, AS CONFED SEQUENCE e AS CONFED SET não são suportados. Isso significa que apenas uma lista de números AS é suportada, e conjuntos e sublistas não são suportados. |
65000 |
|
| AsPathsMatch |
array |
A lista de caminhos AS para correspondência exata. Uma correspondência é bem-sucedida apenas se o caminho AS na condição de correspondência for exatamente igual ao caminho AS da rota correspondente. Este parâmetro e AsPathsInclude são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Nota
Apenas AS SEQUENCE é suportado. AS SET, AS CONFED SEQUENCE e AS CONFED SET não são suportados. Isso significa que apenas uma lista de números AS é suportada, e conjuntos e sublistas não são suportados. |
|
|
integer |
A lista de caminhos AS para correspondência exata. Uma correspondência é bem-sucedida apenas se o caminho AS na condição de correspondência for exatamente igual ao caminho AS da rota correspondente. Este parâmetro e AsPathsInclude são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Nota
Apenas AS SEQUENCE é suportado. AS SET, AS CONFED SEQUENCE e AS CONFED SET não são suportados. Isso significa que apenas uma lista de números AS é suportada, e conjuntos e sublistas não são suportados. |
65000 |
|
| CommunitySetInclude |
array |
O conjunto de comunidades para correspondência aproximada. Uma correspondência é bem-sucedida se a comunidade na condição de correspondência se sobrepor à comunidade da rota correspondente. Cada comunidade está no formato n:m, onde n e m variam de 1 a 65535. A comunidade deve estar em conformidade com o RFC 1997. Comunidades grandes (RFC 8092) não são suportadas. Este parâmetro e CommunitySetMatch são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Nota
Configurações incorretas de comunidade podem impedir que as rotas sejam anunciadas para o data center local. |
|
|
string |
O conjunto de comunidades para correspondência aproximada. Uma correspondência é bem-sucedida se a comunidade na condição de correspondência se sobrepor à comunidade da rota correspondente. Cada comunidade está no formato n:m, onde n e m variam de 1 a 65535. A comunidade deve estar em conformidade com o RFC 1997. Comunidades grandes (RFC 8092) não são suportadas. Este parâmetro e CommunitySetMatch são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Nota
Configurações incorretas de comunidade podem impedir que as rotas sejam anunciadas para o data center local. |
65000:100 |
|
| CommunitySetMatch |
array |
O conjunto de comunidades para correspondência exata. Uma correspondência é bem-sucedida apenas se a comunidade na condição de correspondência for exatamente igual à comunidade da rota correspondente. Cada comunidade está no formato n:m, onde n e m variam de 1 a 65535. A comunidade deve estar em conformidade com o RFC 1997. Comunidades grandes (RFC 8092) não são suportadas. Este parâmetro e CommunitySetInclude são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Nota
Configurações incorretas de comunidade podem impedir que as rotas sejam anunciadas para o data center local. |
|
|
string |
O conjunto de comunidades para correspondência exata. Uma correspondência é bem-sucedida apenas se a comunidade na condição de correspondência for exatamente igual à comunidade da rota correspondente. Cada comunidade está no formato n:m, onde n e m variam de 1 a 65535. A comunidade deve estar em conformidade com o RFC 1997. Comunidades grandes (RFC 8092) não são suportadas. Este parâmetro e CommunitySetInclude são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Nota
Configurações incorretas de comunidade podem impedir que as rotas sejam anunciadas para o data center local. |
65000:100 |
|
| DestinationInstanceIds |
array |
A lista de IDs de instâncias de destino para correspondência. Os seguintes tipos de instância são suportados:
Nota
A lista de IDs de instâncias de destino entra em vigor apenas quando a direção do mapa de rotas é de saída. |
|
|
string |
A lista de IDs de instâncias de destino para correspondência. Os seguintes tipos de instância são suportados:
Nota
A lista de IDs de instâncias de destino entra em vigor apenas quando a direção do mapa de rotas é de saída. |
vbr-gw8jiyiedko141709c903 |
|
| DestinationInstanceIdsReverseMatch |
boolean |
Especifica se o modo de correspondência reversa deve ser usado para a lista de IDs de instâncias de destino. Valores válidos:
|
false |
| DestinationInstanceTypes |
array |
A lista de tipos de instâncias de destino para correspondência. Os seguintes tipos de instância são suportados:
Nota
A lista de tipos de instâncias de destino entra em vigor apenas quando a direção do mapa de rotas é de saída. |
|
|
string |
A lista de tipos de instâncias de destino a serem correspondidas pela rota. Os seguintes tipos de instância são suportados:
Nota
A lista de tipos de instâncias de destino entra em vigor apenas quando a direção do mapa de rotas é de saída. |
VPC |
|
| DestinationRegionIds |
array |
A lista de IDs de regiões de destino para correspondência. |
|
|
string |
A lista de IDs de regiões de destino para correspondência. |
all |
|
| DestinationRouteTableIds |
array |
A lista de IDs de tabelas de rotas de destino para correspondência. Nota
A lista de IDs de tabelas de rotas de destino entra em vigor apenas quando a direção do mapa de rotas é de saída. |
|
|
string |
A lista de IDs de tabelas de rotas de destino a serem correspondidas pela rota. Nota
A lista de IDs de tabelas de rotas de destino entra em vigor apenas quando a direção do mapa de rotas é de saída. |
vtb-wz9x2kcw75vsceun3a0wg |
|
| MatchAddressType |
string |
O tipo de endereço IP para correspondência. Valores válidos:
Se este parâmetro for deixado vazio, todos os tipos de rotas serão correspondidos. |
IPv4 |
| RouteTypes |
array |
A lista de tipos de roteamento para correspondência. Os seguintes tipos de rota são suportados:
Você pode especificar vários tipos de rota. |
|
|
string |
A lista de tipos de roteamento para correspondência. Os seguintes tipos de rota são suportados:
Você pode especificar vários tipos de rota. |
System |
|
| SourceInstanceIds |
array |
A lista de IDs de instâncias de origem para correspondência. Os seguintes tipos de instância são suportados:
|
|
|
string |
A lista de IDs de instâncias de origem para correspondência. Os seguintes tipos de instância são suportados:
|
vpc-2zea9zsh6ce30nfcjlvyr |
|
| SourceInstanceIdsReverseMatch |
boolean |
Especifica se o modo de correspondência reversa deve ser usado para a lista de IDs de instâncias de origem. Valores válidos:
|
false |
| SourceInstanceTypes |
array |
A lista de tipos de instâncias de origem para correspondência. Os seguintes tipos de instância são suportados:
|
|
|
string |
A lista de tipos de instâncias de origem para correspondência. Os seguintes tipos de instância são suportados:
|
VPC |
|
| SourceRegionIds |
array |
A lista de IDs de regiões de origem para correspondência. |
|
|
string |
A lista de IDs de regiões de origem para correspondência. |
cn-hongkong |
|
| SourceRouteTableIds |
array |
A lista de IDs de tabelas de rotas de origem para correspondência. |
|
|
string |
A lista de IDs de tabelas de rotas de origem para correspondência. |
vtb-uf684wwipxgflzkpe4zgd |
|
| Name |
string |
O nome da regra. |
Permit-Prod-Prefixes-Set-LP |
| Priority |
integer |
A prioridade da regra. Um valor menor indica uma prioridade maior. |
10 |
| RouteMapId |
string |
O ID do mapa de rotas. |
rm-0a1b2c3d4e5f6a7b8 |
| SetActions |
object |
As ações a serem executadas para a regra do mapa de rotas. Depois que uma rota atende a todas as condições de correspondência definidas em MatchConditions, o sistema processa a rota com base nas ações definidas neste parâmetro. |
|
| AsPathPrepend |
array |
O caminho AS a ser adicionado ao início quando o gateway regional aceita ou publica entradas de roteamento. Este parâmetro e AsPathReplace são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Este parâmetro especifica a ação a ser executada depois que uma rota atende às condições de correspondência. |
|
|
integer |
O caminho AS a ser adicionado ao início quando o gateway regional aceita ou publica entradas de roteamento. Este parâmetro e AsPathReplace são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Este parâmetro especifica a ação a ser executada depois que uma rota atende às condições de correspondência. |
65000 |
|
| AsPathReplace |
array |
O caminho AS a ser substituído quando o gateway regional aceita ou publica entradas de roteamento. O caminho AS original da rota é substituído pela lista de números AS especificada neste parâmetro. Este parâmetro e AsPathPrepend são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Este parâmetro especifica a ação a ser executada depois que uma rota atende às condições de correspondência. |
|
|
integer |
O caminho AS a ser substituído quando o gateway regional aceita ou publica entradas de roteamento. O caminho AS original da rota é substituído pela lista de números AS especificada neste parâmetro. Este parâmetro e AsPathPrepend são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Este parâmetro especifica a ação a ser executada depois que uma rota atende às condições de correspondência. |
65123 |
|
| CommunityAdd |
array |
O conjunto de comunidades a ser adicionado à rota. Cada comunidade está no formato n:m, onde n e m variam de 1 a 65535. A comunidade deve estar em conformidade com o RFC 1997. Comunidades grandes (RFC 8092) não são suportadas. Este parâmetro e CommunityReplace são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Este parâmetro especifica a ação a ser executada depois que uma rota atende às condições de correspondência. Nota
Configurações incorretas de comunidade podem impedir que as rotas sejam anunciadas para o data center local. |
|
|
string |
O conjunto de comunidades a ser adicionado à rota. Cada comunidade está no formato n:m, onde n e m variam de 1 a 65535. A comunidade deve estar em conformidade com o RFC 1997. Comunidades grandes (RFC 8092) não são suportadas. Este parâmetro e CommunityReplace são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Este parâmetro especifica a ação a ser executada depois que uma rota atende às condições de correspondência. Nota
Configurações incorretas de comunidade podem impedir que as rotas sejam anunciadas para o data center local. |
65000:100 |
|
| CommunityReplace |
array |
O conjunto de comunidades para substituir a comunidade original da rota. Cada comunidade está no formato n:m, onde n e m variam de 1 a 65535. A comunidade deve estar em conformidade com o RFC 1997. Comunidades grandes (RFC 8092) não são suportadas. Este parâmetro e CommunityAdd são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Este parâmetro especifica a ação a ser executada depois que uma rota atende às condições de correspondência. Nota
Configurações incorretas de comunidade podem impedir que as rotas sejam anunciadas para o data center local. |
|
|
string |
O conjunto de comunidades para substituir a comunidade original da rota. Cada comunidade está no formato n:m, onde n e m variam de 1 a 65535. A comunidade deve estar em conformidade com o RFC 1997. Comunidades grandes (RFC 8092) não são suportadas. Este parâmetro e CommunityAdd são mutuamente exclusivos e não podem ser especificados ao mesmo tempo. Este parâmetro especifica a ação a ser executada depois que uma rota atende às condições de correspondência. Nota
Configurações incorretas de comunidade podem impedir que as rotas sejam anunciadas para o data center local. |
65000:200 |
|
| NextPriority |
integer |
Prioridade da política da próxima regra de mapa de rotas associada.
|
1 |
| RouteAction |
string |
A ação de política a ser executada depois que todas as condições forem atendidas. Valores válidos:
|
Permit |
| RouteMapRuleId |
string |
O ID da regra do mapa de rotas. |
rmr-3dm13f66wtctcnydup |
| Status |
string |
O status da regra do mapa de rotas. Valores válidos:
|
Active |
Exemplos
Resposta de sucesso
JSON formato
{
"TotalCount": 2,
"RequestId": "EF44D7B7-6248-5A60-8A4C-A92388605A57",
"NextToken": "dd20****",
"MaxResults": 20,
"RouteMapRules": [
{
"Description": "Matches production prefixes from on-prem and sets a higher local preference.",
"MatchConditions": {
"AddressPrefixesInclude": [
"10.0.0.0/8"
],
"AddressPrefixesMatch": [
"10.0.0.0/8"
],
"AsPathsInclude": [
65000
],
"AsPathsMatch": [
65000
],
"CommunitySetInclude": [
"65000:100"
],
"CommunitySetMatch": [
"65000:100"
],
"DestinationInstanceIds": [
"vbr-gw8jiyiedko141709c903"
],
"DestinationInstanceIdsReverseMatch": false,
"DestinationInstanceTypes": [
"VPC"
],
"DestinationRegionIds": [
"all"
],
"DestinationRouteTableIds": [
"vtb-wz9x2kcw75vsceun3a0wg"
],
"MatchAddressType": "IPv4",
"RouteTypes": [
"System"
],
"SourceInstanceIds": [
"vpc-2zea9zsh6ce30nfcjlvyr"
],
"SourceInstanceIdsReverseMatch": false,
"SourceInstanceTypes": [
"VPC"
],
"SourceRegionIds": [
"cn-hongkong"
],
"SourceRouteTableIds": [
"vtb-uf684wwipxgflzkpe4zgd"
]
},
"Name": "Permit-Prod-Prefixes-Set-LP",
"Priority": 10,
"RouteMapId": "rm-0a1b2c3d4e5f6a7b8",
"SetActions": {
"AsPathPrepend": [
65000
],
"AsPathReplace": [
65123
],
"CommunityAdd": [
"65000:100"
],
"CommunityReplace": [
"65000:200"
],
"NextPriority": 1,
"RouteAction": "Permit"
},
"RouteMapRuleId": "rmr-3dm13f66wtctcnydup",
"Status": "Active"
}
]
}
Códigos de erro
|
Código de status HTTP |
Código de erro |
Mensagem de erro |
Descrição |
|---|---|---|---|
| 400 | IllegalParam.NextToken | NextToken is illegal | O NextToken é inválido. |
| 400 | InvalidParameter.MaxResults | The specified MaxResults is invalid. | O parâmetro MaxResults especificado é inválido. |
| 400 | InvalidParameter.RouteMapIds | The specified RouteMapIds is invalid. | O parâmetro RouteMapIds especificado é inválido. |
| 400 | InvalidParameter.Filter | The specified Filter is invalid. | O parâmetro Filter especificado é inválido. |
| 400 | InvalidParameter.RouteMapRuleIds | The specified parameter "RouteMapRuleIds" is invalid. | O parâmetro RouteMapRuleIds especificado é inválido. |
| 400 | InvalidParameter.RouteMapId | The specified parameter RouteMapId is invalid. | O parâmetro RouteMapId especificado é inválido. |
| 400 | MissingParameter.RouteMapIdOrRouteMapRuleIds | The input parameter "RouteMapId" or "RouteMapRuleIds" that is mandatory for processing this request is not supplied. | O parâmetro de solicitação RouteMapId ou RouteMapRuleIds está ausente. |
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.