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

Consulta os detalhes das políticas de marcação de tráfego, como status e prioridade.

Descrição da operação

Ao chamar a operação ListTrafficMarkingPolicies:

Você deve especificar pelo menos um dos parâmetros TransitRouterId e TrafficMarkingPolicyId.
Se você não especificar o parâmetro TrafficMarkingPolicyId, a operação retornará apenas informações sobre a política de marcação de tráfego com base nos parâmetros TransitRouterId, TrafficMarkingPolicyName e TrafficMarkingPolicyDescription. As informações sobre as regras de classificação de tráfego não são retornadas. O campo TrafficMatchRules não é incluído na resposta.
Se você especificar o parâmetro TrafficMarkingPolicyId, a operação retornará informações sobre a política de marcação de tráfego e suas regras de classificação de tráfego. O campo TrafficMatchRules é incluído na resposta. Se o campo TrafficMatchRules for uma matriz vazia, nenhuma regra de classificação de tráfego estará configurada para a política.

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

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
TransitRouterId	string	Não	O ID da instância TransitRouter.	tr-bp1rmwxnk221e3fas****
TrafficMarkingPolicyId	string	Não	O ID da política de marcação de tráfego.	tm-iz5egnyitxiroq****
TrafficMarkingPolicyName	string	Não	O nome da política de marcação de tráfego. O nome pode estar vazio ou ter de 1 a 128 caracteres. Não pode começar com http:// ou https://.	nametest
TrafficMarkingPolicyDescription	string	Não	A descrição da política de marcação de tráfego. A descrição pode estar vazia ou ter de 1 a 256 caracteres. Não pode começar com http:// ou https://.	desctest
MaxResults	integer	Não	O número de entradas a serem retornadas em cada página. Valores válidos: 1 a 100. Valor padrão: 20.	20
NextToken	string	Não	O token usado para a próxima consulta. Valores válidos: Não é necessário especificar este parâmetro na primeira consulta. Se uma próxima consulta for enviada, defina o valor como o valor de NextToken retornado na última chamada de API.	FFmyTO70tTpLG6I3FmYAXGKPd****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
NextToken	string	O token usado para a próxima consulta. Se NextToken estiver vazio, nenhuma próxima consulta será enviada. Se um valor for retornado para NextToken, o valor é o token usado para a próxima consulta.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	O ID da solicitação.	699989E4-64A0-5F78-8B93-CDB32D98971F
TotalCount	integer	O número de entradas retornadas.	1
MaxResults	integer	O número de entradas retornadas por página.	20
TrafficMarkingPolicies	array<object>	A lista de políticas de marcação de tráfego.
	array<object>	As informações sobre a política de marcação de tráfego.
TrafficMarkingPolicyStatus	string	O status da política de marcação de tráfego. Creating: A política está sendo criada. Active: A política está disponível. Modifying: A política está sendo modificada. Deleting: A política está sendo excluída.	Creating
TrafficMarkingPolicyId	string	O ID da política de marcação de tráfego.	tm-iz5egnyitxiroq****
MarkingDscp	integer	O valor do Differentiated Services Code Point (DSCP) da política de marcação de tráfego.	5
TrafficMarkingPolicyName	string	O nome da política de marcação de tráfego.	nametest
Priority	integer	A prioridade da política de marcação de tráfego. Um valor menor indica uma prioridade maior.	5
TrafficMarkingPolicyDescription	string	A descrição da política de marcação de tráfego.	desctest
TrafficMatchRules	array<object>	A lista de regras de classificação de tráfego.
	object	As informações sobre a regra de classificação de tráfego.
MatchDscp	integer	The DSCP value of the traffic message. Nota If MatchDscp returns -1, it indicates that all DSCP values are matched.	6
DstCidr	string	The destination CIDR block of the traffic message. IPv4 and IPv6 addresses are supported.	192.168.120.0/24
TrafficMatchRuleDescription	string	The description of the traffic classification rule.	desctest
Protocol	string	The protocol type of the traffic message. Nota A traffic marking policy supports matching multiple protocol types. For more information about the protocol types, see the relevant documentation.	HTTP
TrafficMatchRuleId	string	The ID of the traffic classification rule.	tm-rule-fa9kgq1e90rmhc****
SrcCidr	string	The source CIDR block of the traffic message. IPv6 and IPv4 addresses are supported.	192.168.10.0/24
TrafficMatchRuleName	string	The name of the traffic classification rule.	nametest
TrafficMatchRuleStatus	string	The status of the traffic classification rule. Creating: The rule is being created. Active: The rule is available. Deleting: The rule is being deleted.	Creating
AddressFamily	string	The address type. Valid values are IPv4, IPv6, or empty.	IPv4
DstPortRange	array	The destination port range to be matched by the traffic classification rule.
	integer	The destination port range to be matched by the traffic classification rule. The operation returns two destination port numbers: If the two destination port numbers are the same, for example, 80 and 80, the traffic classification rule matches traffic with a destination port of 80. `If both destination port numbers are -1, the stream classification rule matches traffic with any destination port number.` If both destination port numbers are -1, the traffic classification rule matches traffic with any destination port.	80,80
SrcPortRange	array	The source port range to be matched by the traffic classification rule.
	integer	The source port range to be matched by the traffic classification rule. The operation returns two source port numbers: If the two source port numbers are the same, for example, 80 and 80, the traffic classification rule matches traffic with a source port of 80. `If both source port numbers are -1, the stream classification rule matches traffic with any source port number.` If both source port numbers are -1, the traffic classification rule matches traffic with any source port.	1,200
TransitRouterId	string	O ID da instância TransitRouter.	tr-ccni***

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "699989E4-64A0-5F78-8B93-CDB32D98971F",
  "TotalCount": 1,
  "MaxResults": 20,
  "TrafficMarkingPolicies": [
    {
      "TrafficMarkingPolicyStatus": "Creating",
      "TrafficMarkingPolicyId": "tm-iz5egnyitxiroq****",
      "MarkingDscp": 5,
      "TrafficMarkingPolicyName": "nametest",
      "Priority": 5,
      "TrafficMarkingPolicyDescription": "desctest",
      "TrafficMatchRules": [
        {
          "MatchDscp": 6,
          "DstCidr": "192.168.120.0/24",
          "TrafficMatchRuleDescription": "desctest",
          "Protocol": "HTTP",
          "TrafficMatchRuleId": "tm-rule-fa9kgq1e90rmhc****",
          "SrcCidr": "192.168.10.0/24",
          "TrafficMatchRuleName": "nametest",
          "TrafficMatchRuleStatus": "Creating",
          "AddressFamily": "IPv4",
          "DstPortRange": [
            0
          ],
          "SrcPortRange": [
            0
          ]
        }
      ],
      "TransitRouterId": "tr-ccni***"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParam.TransitRouterIdOrTrafficMarkingPolicyId	Either TransitRouterId or TrafficMarkingPolicyId must be specified.	The error message returned because the TransitRouterId or TrafficMarkingPolicyId parameter is not set.
400	IllegalParam.NextToken	The specified NextToken is invalid.	The error message returned because the NextToken parameter is set to an invalid value.
400	InvalidName	Name is invalid.	The error message returned because the specified name is invalid.
400	InvalidDescription	Description is invalid.	The error message returned because the description is invalid.
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.