CreatePlanMaintenanceWindow - Elastic Compute Service: Central de Documentação do Alibaba Cloud

Cria uma janela de O&M. Quando o parâmetro TargetResource da janela de O&M está associado a instâncias ECS e os riscos de hardware subjacentes exigem O&M agendado para mitigação, o horário de execução do O&M agendado é determinado pelo intervalo de tempo especificado no parâmetro TimePeriod. Quando o horário de execução de um evento de O&M chega, a plataforma executa automaticamente as operações de O&M correspondentes com base no tipo de evento.

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

ecs:CreatePlanMaintenanceWindow

create

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PlanWindowName	string	Sim	O nome da janela de O&M. Você pode personalizar o nome. O nome pode ter até 200 caracteres.	WIndowName
Enable	boolean	Sim	Especifica se a janela deve ser ativada ou desativada. true: Ativada. false: Desativada.	true
SupportMaintenanceAction	string	Sim	As operações de O&M suportadas pela janela de O&M. Valores válidos: Redeploy : Redeploy. Reboot : Reinicialização.	Reboot
RegionId	string	Sim	O ID da região. Este parâmetro é obrigatório para o roteamento do SDK da Alibaba Cloud. No entanto, especificar qualquer ID de região para esta operação produz o mesmo resultado. A janela de O&M se aplica a todas as instâncias ECS em toda a rede que atendem às condições de filtragem de recursos.	cn-hangzhou
TimePeriod	object	Sim	O ciclo de recorrência da janela.
PeriodUnit	string	Sim	O tipo do ciclo. Valores válidos: Daily e Weekly. Valores válidos: Daily : Diário. Weekly : Semanal.	Weekly
RangeList	array<object>	Sim	Os intervalos de tempo do ciclo de recorrência da janela de O&M em UTC.
	object	Não	O item de intervalo de tempo.
StartTime	string	Não	O horário de início da janela de O&M. Se PeriodUnit estiver definido como Weekly, o formato é Monday,22:00. Monday pode ser substituído por Tuesday, Wednesday, Thursday, Friday, Saturday ou Sunday. Se PeriodUnit estiver definido como Daily, o formato é 22:00. A vírgula (,) é usada como separador. A primeira parte representa a hora, com valores válidos de 00 a 23. A segunda parte representa o minuto. Atualmente, apenas 00 é suportado.	Monday,22:00
EndTime	string	Não	O horário de término da janela de O&M. Se PeriodUnit estiver definido como Weekly, o formato é Monday,22:00. Monday pode ser substituído por Tuesday, Wednesday, Thursday, Friday, Saturday ou Sunday. Se PeriodUnit estiver definido como Daily, o formato é 22:00. A vírgula (,) é usada como separador. A primeira parte representa a hora, com valores válidos de 00 a 23. A segunda parte representa o minuto. Atualmente, apenas 00 é suportado.	Tuesday,03:00
TargetResource	object	Sim	Os recursos aos quais a janela de O&M se aplica.
Scope	string	Sim	O tipo de recurso configurado para a janela de O&M. Valores válidos: All : Todos. Tag : Tag. ResourceGroup : ResourceGroup.	Tag
ResourceGroupId	string	Não	O ID do grupo de recursos. Este parâmetro é obrigatório quando Scope está definido como ResourceGroup.	rg-aekzhm7pmnvcbty
Tags	array<object>	Não	As tags às quais a janela de O&M se aplica. Este parâmetro é obrigatório quando Scope está definido como Tag.
	object	Não	O valor da tag.
Key	string	Não	A chave da tag à qual a janela se aplica.	vms_qualification_Mr_Sun_ID_card_e5590864-1fef-4db2-b2a7-bd2d657fed43.png
Value	string	Não	O valor da tag à qual a janela se aplica.	21.137.18.60
MinMaintenanceInterval	integer	Não

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	7D5B1188-3F08-56D1-A6B2-91B267452633
PlanWindowId	string	O ID da janela de O&M criada.	pw-bp1a9yavgq3dgttvowun

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "7D5B1188-3F08-56D1-A6B2-91B267452633",
  "PlanWindowId": "pw-bp1a9yavgq3dgttvowun"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidOperation.TooManyMaintenanceWindows	Too many maintenance windows.	O número de configurações de janela de manutenção excede 200. Não é possível criar mais janelas.
500	InternalError	Internal error.	Ocorreu um erro interno. Tente novamente.
403	AccessForbidden	User not authorized to operate on the specified resource.	Você não está autorizado a usar o recurso especificado.
403	MissingParameter.Period	The input parameter Period is missing.	O parâmetro Period está ausente.
403	MissingParameter.TargetType	The input parameter TargetType is missing.	O parâmetro TargetType está ausente.
403	InvalidParameter.TimePeriod	Invalid Parameter Time Period.	A propriedade Time Period está configurada incorretamente.
403	InvalidParameter.TargetResource	Invalid Parameter Target Resource.	A propriedade TargetResource está configurada incorretamente.
403	InvalidParameter.SupportMaintenanceAction	Invalid Parameter SupportMaintenanceAction.	A propriedade SupportMaintenanceAction está configurada incorretamente.
403	InvalidParameter.MinMaintenanceInterval	Invalid Parameter MinMaintenanceInterval.	O parâmetro MinMaintenanceInterval está configurado incorretamente.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.