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

Cria uma política de agendamento de tráfego entre regiões para um roteador de trânsito Enterprise Edition, a fim de otimizar e controlar o tráfego de rede entre regiões.

Descrição da operação

Apenas conexões inter-regionais de roteadores de trânsito Enterprise Edition suportam a criação de políticas de agendamento de tráfego entre regiões.
O recurso de agendamento de tráfego entra em vigor apenas na direção de saída de um roteador de trânsito Enterprise Edition.

Por exemplo, se você criar uma conexão inter-regional entre as regiões China (Hangzhou) e China (Qingdao) e configurar o recurso de agendamento de tráfego no roteador de trânsito da região China (Hangzhou), o recurso de agendamento de tráfego poderá garantir largura de banda para vários serviços quando o tráfego fluir da região China (Hangzhou) para a região China (Qingdao). No entanto, o recurso de agendamento de tráfego não garante a largura de banda do serviço quando o tráfego flui da região China (Qingdao) para a região China (Hangzhou).
CreateCenInterRegionTrafficQosPolicy é uma operação assíncrona. Após enviar uma solicitação, o sistema retorna um ID de política de agendamento de tráfego, mas a política ainda não foi criada. A tarefa de criação continua sendo executada em segundo plano. Você pode chamar ListCenInterRegionTrafficQosPolicies para consultar o status da política de agendamento de tráfego.
- Se a política de agendamento de tráfego estiver no estado Creating, a política está sendo criada. Nesse estado, você só pode consultar a política, mas não pode executar outras operações nela.
- Se a política de agendamento de tráfego estiver no estado Active, a política foi criada.

Antes de começar

Antes de chamar CreateCenInterRegionTrafficQosPolicy, certifique-se de que as seguintes condições sejam atendidas:

Uma conexão inter-regional foi criada. Para mais informações, consulte CreateTransitRouterPeerAttachment.
Uma política de marcação de tráfego foi criada. Para mais informações, consulte CreateTrafficMarkingPolicy.

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

create

*All Resource

*

Nenhuma

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 usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento.	123e4567-e89b-12d3-a456-426655****
DryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: realiza um dry run. O sistema verifica os parâmetros obrigatórios, a sintaxe da solicitação e as restrições de negócios. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o código de erro `DryRunOperation` será retornado. false (padrão): realiza um dry run e envia a solicitação. Se a solicitação passar no dry run, a política de agendamento de tráfego será criada.	false
TransitRouterId	string	Sim	O ID da instância do roteador de trânsito.	tr-8vbuqeo5h5pu3m01d****
TransitRouterAttachmentId	string	Sim	O ID da conexão inter-regional.	tr-attach-r6g0m3epjehw57****
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 de comprimento 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 de comprimento e não pode começar com http:// ou https://.	desctest
BandwidthGuaranteeMode	string	Não	O modo de garantia de largura de banda. Você pode configurar filas QoS com base em valores absolutos de largura de banda ou porcentagens de largura de banda. Valores válidos: byBandwidth: configura filas QoS com base em valores absolutos de largura de banda. byBandwidthPercent (padrão): configura filas QoS com base em porcentagens de largura de banda.	byBandwidthPercent
TrafficQosQueues	array<object>	Não	As informações da fila da política de agendamento de tráfego. Você pode criar até 3 filas. Para criar mais filas, chame CreateCenInterRegionTrafficQosQueue.
	object	Não	As informações da fila.
QosQueueName	string	Não	O nome da fila. Uma política de agendamento de tráfego suporta até 3 filas, e cada fila pode receber um nome. O nome pode estar vazio ou ter de 1 a 128 caracteres de comprimento e não pode começar com http:// ou https://.	nametest
RemainBandwidthPercent	string	Não	A porcentagem da largura de banda inter-regional que a fila pode usar. Uma política de agendamento de tráfego suporta até 10 filas, e cada fila pode receber uma porcentagem da largura de banda inter-regional. Por exemplo, se você inserir 1, o tráfego correspondente à fila poderá usar até 1% da largura de banda inter-regional. Nota A soma das porcentagens de largura de banda de todas as filas em uma política de agendamento de tráfego não pode exceder 100%.	1
Bandwidth	string	Não	O valor absoluto de largura de banda que a fila pode usar para tráfego inter-regional, em Mbit/s. Uma política de agendamento de tráfego suporta até 10 filas, e cada fila pode receber um valor absoluto de largura de banda. Por exemplo, se você inserir 1, o tráfego correspondente à fila poderá usar até 1 Mbit/s da largura de banda inter-regional. Nota A soma dos valores absolutos de largura de banda de todas as filas alocadas em uma política de agendamento de tráfego não pode exceder o valor da largura de banda inter-regional.	1
Dscps	array	Não	Os valores DSCP correspondentes à fila. Uma política de agendamento de tráfego suporta até 3 filas, e cada fila pode corresponder a até 60 valores DSCP. Separe múltiplos valores DSCP com vírgulas (,).
	integer	Não	Os valores DSCP correspondentes à fila. Uma política de agendamento de tráfego suporta até 3 filas, e cada fila pode corresponder a até 60 valores DSCP. Separe múltiplos valores DSCP com vírgulas (,).	5
QosQueueDescription	string	Não	A descrição da fila. Uma política de agendamento de tráfego suporta até 10 filas, e cada fila pode ter uma descrição. A descrição pode estar vazia ou ter de 1 a 256 caracteres de comprimento e não pode começar com http:// ou https://.	desctest
ConsoleDryRun	boolean	Não	Especifica se deve ser realizado um dry run. Valores válidos: true: realiza um dry run. O sistema verifica os parâmetros obrigatórios, a sintaxe da solicitação e as restrições de negócios. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o código de erro `DryRunOperation` será retornado. false (padrão): realiza um dry run e envia a solicitação. Se a solicitação passar no dry run, a política de agendamento de tráfego entre regiões será criada.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
TrafficQosPolicyId	string	O ID da política de agendamento de tráfego.	qos-eczzew0v1kzrb5****
RequestId	string	O ID da solicitação.	6DF9A765-BCD2-5C7E-8C32-C35C8A361A39

Exemplos

Resposta de sucesso

JSON formato

{
  "TrafficQosPolicyId": "qos-eczzew0v1kzrb5****",
  "RequestId": "6DF9A765-BCD2-5C7E-8C32-C35C8A361A39"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	AssociationExist.TrafficQos	The traffic qos with the specified attachment already exists.	Já existe uma política de marcação de tráfego para este anexo.
400	InvalidTransitRouterId.NotFound	The specified TransitRouterId is not found.	O TransitRouterId especificado na solicitação não existe.
400	IllegalParam.TransitRouterAttachmentId	TransitRouterAttachmentId is illegal.	O TrInstance especificado na solicitação é inválido.
400	InvalidParamSize.TrafficQosQueues	The queue size included in the traffic QoS policy exceeds the limit.	O número de filas na política de marcação de tráfego excede o limite.
400	IllegalParam.BandwidthGuaranteeModeMismatch	The BandwidthGuaranteeMode does not match the Bandwidth or RemainBandwidthPercent.	O tipo de garantia de largura de banda não corresponde ao valor absoluto de largura de banda ou ao tipo de porcentagem.
400	IllegalParam.AttachmentBandwidthExceed	The entered bandwidth causes the total QoS guaranteed bandwidth to exceed the cross-region bandwidth allocation value.	A largura de banda especificada faz com que a largura de banda garantida total de QoS exceda o valor de alocação de largura de banda inter-regional.
400	IllegalParam.BandwidthGuaranteeMode	The input bandwidth guarantee type is not valid.	O tipo de garantia de largura de banda especificado é inválido.
400	MissingParam.RemainBandwidthPercent	RemainBandwidthPercent is missing.	A porcentagem de largura de banda garantida está ausente.
400	MissingParam.Bandwidth	The parameter Bandwidth is mandatory.	O parâmetro de valor de largura de banda é obrigatório.
400	IllegalParam.RemainBandwidthPercent	The specified RemainBandwidthPercent is invalid.	O RemainBandwidthPercent especificado na solicitação é inválido.
400	IllegalParam.Bandwidth	Bandwidth is illegal	O ID do pacote de largura de banda é inválido.
400	IllegalParam.BandwidthPackageStatus	The status of the bandwidth package is incorrect.	O pacote de largura de banda está em um estado incorreto.
400	IncorrectStatus.TransitRouterInstance	The status of TransitRouter is incorrect.	O roteador de trânsito está em um estado inválido.
400	IncorrectStatus.TransitRouterAttachment	TransitRouterAttachmentId status is invalid.	O status atual do TransitRouterAttachment não suporta esta operação. Tente novamente mais tarde.
400	InvalidParameter	Invalid parameter.	O parâmetro é inválido.
400	Unauthorized	The AccessKeyId is unauthorized.	A conta não tem as permissões necessárias para realizar esta operação.
400	MissingParam.TransitRouterId	The parameter TransitrouterId is mandatory.	O parâmetro TransitRouterId está ausente.
400	MissingParam.TransitRouterAttachmentId	The parameter TransitRouterAttachmentId is Missing.	O parâmetro TransitRouterAttachmentId está ausente.
400	Forbidden.CDTServiceExpired	The CDT service is out of service.	O serviço Cloud Data Transfer (CDT) foi suspenso devido a pagamento em atraso. Renove o serviço e tente novamente.
400	OperationUnsupported.TransitRouterType	The specified TransitRouterType does not support the operation.	Esta operação não é suportada para o tipo atual de roteador de trânsito.
400	OperationUnsupported.QosPolicyForLowLatencyLinkType	QoS Policy is not supported for Low Latency LinkType.	Links de baixa latência não suportam configuração de política de QoS.
400	InvalidTransitRouterAttachmentId.NotFound	TransitRouterAttachmentId is not found.	O TransitRouterAttachmentId especificado na solicitação não existe.
400	IncorrectStatus.TransitRouterAttachmentId	The resource is not in a valid state for the attachment operation.	A conexão não está em um estado estável e não suporta esta operação.
400	InvalidOperation.QueueLinkTypeNotEqualsAttachmentLinkType	The operation is invalid because the link type of an existing QoS queue does not match the link type of the attachment.	Na política de QoS configurada, o tipo de link de uma fila difere do tipo de link da conexão inter-regional.
400	ParamMismatch.BandwidthGuaranteeModeAndQueueSchedulingMode	The parameters BandwidthGuaranteeMode and QueueSchedulingMode are incompatible.	Os parâmetros BandwidthGuaranteeMode e QueueSchedulingMode não correspondem.
400	InvalidOperation.NotSupportHierarchicalQoS	The operation is invalid because the transit router does not support HierarchicalQoS.	O roteador de trânsito atual não oferece suporte a QoS no modo de agendamento por prioridade.
400	InvalidOperation.QueuesExceeded	The operation is invalid because the maximum queue quota for HierarchicalQoS has been exceeded.	Muitas filas foram especificadas.
400	ParamMismatch.QueueSchedulingModeAndBandwidth	The parameters QueueSchedulingMode and Bandwidth are incompatible.	Os parâmetros QueueSchedulingMode e Bandwidth não correspondem.
400	IllegalParam.QueueType	The parameter QueueType is illegal.	O parâmetro QueueType é inválido.
400	ParamMismatch.QueueTypeAndBandwidthPercent	The parameters QueueType and BandwidthPercent are incompatible.	Os parâmetros QueueType e BandwidthPercent não correspondem.
400	InvalidOperation.PriorityQueueExceeded	The operation is invalid because HierarchicalQoS supports only one priority queue.	A criação de múltiplas filas de prioridade não é suportada.
400	ParamMismatch.QueueSchedulingModeAndQueueType	The parameters QueueSchedulingMode and QueueType are incompatible.	Os parâmetros QueueSchedulingMode e QueueType não correspondem.
400	ParamMismatch.QueueSchedulingModeAndLinkType	The parameters QueueSchedulingMode and LinkType are incompatible.	Os parâmetros QueueSchedulingMode e LinkType não correspondem.
400	IllegalParam.QueueSchedulingMode	The parameter QueueSchedulingMode is illegal.	O parâmetro QueueSchedulingMode é inválido.
400	InvalidOperation.TransitRouterNotSupportHierarchicalQoS	The operation is invalid because the transit router does not support HierarchicalQoS.	O roteador de trânsito atual não oferece suporte a QoS no modo de agendamento por prioridade.
400	InvalidParameter.TransitRouterAttachmentId	The specified parameter TransitRouterAttachmentId is invalid.
400	InvalidParameter.TransitRouterId	The specified parameter TransitRouterId is invalid.	O parâmetro TransitRouterId é inválido.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.