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

Consulta informações sobre políticas de agendamento de tráfego chamando a operação ListCenInterRegionTrafficQosPolicies.

Descrição da operação

Ao chamar a operação ListCenInterRegionTrafficQosPolicies:

Especifique pelo menos um dos parâmetros TransitRouterId e TrafficQosPolicyId.
Se você não especificar um ID de política de agendamento de tráfego (ou seja, não especificar o parâmetro TrafficQosPolicyId), a operação retornará apenas as informações da política de agendamento de tráfego com base nos valores dos parâmetros TransitRouterId, TransitRouterAttachmentId, TrafficQosPolicyName e TrafficQosPolicyDescription. As informações da fila sob a política de agendamento de tráfego não são retornadas (ou seja, a resposta não inclui o campo TrafficQosQueues).
Se você especificar um ID de política de agendamento de tráfego (ou seja, especificar o parâmetro TrafficQosPolicyId), a operação retornará as informações da política de agendamento de tráfego e as informações da fila sob a política de agendamento de tráfego (ou seja, a resposta inclui o campo TrafficQosQueues). Se o campo TrafficQosQueues for um array vazio, apenas a fila padrão existe sob a política de agendamento de tráfego.
Certifique-se de que os valores dos parâmetros especificados estejam corretos. Se você especificar valores de parâmetros incorretos, a operação ainda retornará um RequestId, mas não retornará as informações da política de agendamento de tráfego.

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

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 do roteador de trânsito.	tr-bp1rmwxnk221e3fas****
TransitRouterAttachmentId	string	Não	O ID da conexão inter-regional.	tr-attach-r6g0m3epjehw57****
TrafficQosPolicyId	string	Não	O ID da política de agendamento de tráfego.	qos-rnghap5gc8155x****
TrafficQosPolicyName	string	Não	O nome da política de agendamento de tráfego. O nome pode estar vazio ou ter de 1 a 128 caracteres e não pode começar com http:// ou https://.	nametest
TrafficQosPolicyDescription	string	Não	A descrição da política de agendamento de tráfego. A descrição pode estar vazia ou ter de 1 a 256 caracteres e não pode começar com http:// ou https://.	desctest
MaxResults	integer	Não	O número de entradas por página para uma consulta paginada. Valores válidos: 1 a 100. Valor padrão: 20.	20
NextToken	string	Não	O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Valores válidos: Você não precisa especificar este parâmetro na primeira solicitação ou se não existir uma próxima consulta. Se existir uma próxima consulta, defina o valor como o valor de NextToken retornado na chamada de API anterior.	FFmyTO70tTpLG6I3FmYAXGKPd****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
NextToken	string	O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Se NextToken estiver vazio, não existe uma próxima consulta. Se NextToken for retornado, o valor indica o token para a próxima consulta.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	O ID da solicitação.	113BFD47-63DF-5D9D-972C-033FB9C360CD
TotalCount	integer	O número total de entradas retornadas.	1
MaxResults	integer	O número de entradas por página para uma consulta paginada.	20
TrafficQosPolicies	array<object>	A lista de políticas de agendamento de tráfego.
	array<object>	As informações sobre a política de agendamento de tráfego.
TrafficQosPolicyName	string	O nome da política de agendamento de tráfego.	nametest
TrafficQosPolicyStatus	string	O status da política de agendamento de tráfego. Creating: sendo criada. Active: ativa. Modifying: sendo modificada. Deleting: sendo excluída.	Creating
TrafficQosPolicyId	string	O ID da política de agendamento de tráfego.	qos-rnghap5gc8155x****
TrafficQosPolicyDescription	string	A descrição da política de agendamento de tráfego.	desctest
BandwidthGuaranteeMode	string	O tipo de garantia de largura de banda. Valores válidos: byBandwidth: configura filas de QoS por valor absoluto de largura de banda. byBandwidthPercent: configura filas de QoS por porcentagem de largura de banda.	byBandwidthPercent
TrafficQosQueues	array<object>	A lista de filas.
	object	As informações sobre a fila.
QosQueueName	string	O nome da fila.	namtest
RemainBandwidthPercent	integer	A porcentagem da largura de banda inter-regional ocupada pela fila atual quando o tipo de garantia de largura de banda está definido como modo de porcentagem.	1
Bandwidth	string	A largura de banda inter-regional alocada à fila atual quando o tipo de garantia de largura de banda está definido como modo de valor absoluto.	1
QosQueueId	string	O ID da fila.	qos-queue-njcrmr9fiu1jii****
QosQueueDescription	string	A descrição da fila.	desctest
Dscps	array	Os valores DSCP dos pacotes de tráfego a serem correspondidos pela fila atual.
	integer	Os valores DSCP dos pacotes de tráfego a serem correspondidos pela fila atual.	5
EffectiveBandwidth	string	A largura de banda efetiva real da fila atual.	1.35
TransitRouterId	string	O ID da instância do roteador de trânsito.	tr-2ze4ta4v32umj0rb***
TransitRouterAttachmentId	string	O ID da conexão da instância de rede.	tr-attach-q7ct7c06jpw***

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "113BFD47-63DF-5D9D-972C-033FB9C360CD",
  "TotalCount": 1,
  "MaxResults": 20,
  "TrafficQosPolicies": [
    {
      "TrafficQosPolicyName": "nametest",
      "TrafficQosPolicyStatus": "Creating",
      "TrafficQosPolicyId": "qos-rnghap5gc8155x****",
      "TrafficQosPolicyDescription": "desctest",
      "BandwidthGuaranteeMode": "byBandwidthPercent",
      "TrafficQosQueues": [
        {
          "QosQueueName": "namtest",
          "RemainBandwidthPercent": 1,
          "Bandwidth": "1",
          "QosQueueId": "qos-queue-njcrmr9fiu1jii****",
          "QosQueueDescription": "desctest",
          "Dscps": [
            5
          ],
          "EffectiveBandwidth": "1.35"
        }
      ],
      "TransitRouterId": "tr-2ze4ta4v32umj0rb***",
      "TransitRouterAttachmentId": "tr-attach-q7ct7c06jpw***"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParam.TransitRouterIdOrTrafficQosPolicyId	Either TransitRouterId or TrafficQosPolicyId must be specified.
400	InvalidDescription	Description is invalid.	A descrição é inválida.
400	InvalidName	Name is invalid.	O nome é inválido.
400	InvalidParameter	Invalid parameter.	O parâmetro é inválido.
400	Unauthorized	The AccessKeyId is unauthorized.	A conta não tem permissão para realizar esta operação.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.