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

Consulta as políticas de Qualidade de Serviço (QoS).

Descrição da operação

Observe os seguintes itens ao chamar a operação ListCenInterRegionTrafficQosPolicies:

Você deve especificar pelo menos um dos parâmetros TransitRouterId e TrafficQosPolicyId.
Se você não especificar o parâmetro TrafficQosPolicyId, a operação retornará informações sobre a política de QoS com base nos valores dos parâmetros TransitRouterId, TransitRouterAttachmentId, TrafficQosPolicyName e TrafficQosPolicyDescription. Nesse caso, as informações sobre as filas na política não são retornadas, e o campo TrafficQosQueues não é incluído na resposta.
Se você especificar o parâmetro TrafficQosPolicyId, a operação retornará informações sobre a política de QoS e suas filas. O campo TrafficQosQueues é incluído na resposta. Se o campo TrafficQosQueues for um array vazio, apenas a fila padrão existe na política de QoS.
Certifique-se de inserir valores de parâmetros válidos. Se você inserir um parâmetro inválido, o sistema retornará um RequestId, mas não retornará informações sobre a política de QoS.

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 TransitRouter.	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 QoS.	qos-rnghap5gc8155x****
TrafficQosPolicyName	string	Não	O nome da política de QoS. O nome pode estar vazio ou ter de 1 a 128 caracteres. Não pode começar com http:// ou https://.	nametest
TrafficQosPolicyDescription	string	Não	A descrição da política de QoS. 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 para a próxima página de resultados. Valores válidos: Se esta for sua primeira consulta ou se não existir uma próxima página, não especifique este parâmetro. Se existir uma próxima página, defina o valor como o valor de NextToken retornado na chamada anterior.	FFmyTO70tTpLG6I3FmYAXGKPd****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta retornada.
NextToken	string	Um token de paginação. Pode ser usado na próxima solicitação para recuperar uma nova página de resultados. Se NextToken estiver vazio, não existe uma próxima página. Se um valor for retornado para NextToken, o valor é o token que determina o ponto inicial da próxima consulta.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	O ID da solicitação.	113BFD47-63DF-5D9D-972C-033FB9C360CD
TotalCount	integer	O número de entradas retornadas.	1
MaxResults	integer	O número de entradas retornadas por página.	20
TrafficQosPolicies	array<object>	A lista de políticas de QoS.
	array<object>	As informações sobre a política de QoS.
TrafficQosPolicyName	string	O nome da política de QoS.	nametest
TrafficQosPolicyStatus	string	O status da política de QoS. Creating: A política está sendo criada. Active: A política está ativa. Modifying: A política está sendo modificada. Deleting: A política está sendo excluída.	Creating
TrafficQosPolicyId	string	O ID da política de QoS.	qos-rnghap5gc8155x****
TrafficQosPolicyDescription	string	A descrição da política de QoS.	desctest
BandwidthGuaranteeMode	string	O tipo de garantia de largura de banda. byBandwidth: As filas de QoS são configuradas com base em um valor absoluto de largura de banda. byBandwidthPercent: As filas de QoS são configuradas com base em uma porcentagem de largura de banda.	byBandwidthPercent
TrafficQosQueues	array<object>	A lista de filas.
	object	As informações sobre a fila.
QosQueueName	string	The name of the queue.	namtest
RemainBandwidthPercent	integer	The percentage of the inter-region connection bandwidth that is used by the queue. This parameter is returned when the bandwidth guarantee type is byBandwidthPercent.	1
Bandwidth	string	The bandwidth value allocated to the queue of the inter-region connection. This parameter is returned when the bandwidth guarantee type is byBandwidth.	1
QosQueueId	string	The ID of the queue.	qos-queue-njcrmr9fiu1jii****
QosQueueDescription	string	The description of the queue.	desctest
Dscps	array	The Differentiated Services Code Point (DSCP) values of the traffic messages that are matched by the queue.
	integer	The DSCP value of a traffic message that is matched by the queue.	5
EffectiveBandwidth	string	The actual bandwidth of the queue.	1.35
TransitRouterId	string	O ID da instância TransitRouter.	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.	The error message returned because the description is invalid.
400	InvalidName	Name is invalid.	The error message returned because the specified name 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.