CreatePlanMaintenanceWindow - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Crea una ventana de O&M. Cuando el parámetro TargetResource de la ventana de O&M se asocia con instancias de ECS y los riesgos de hardware subyacente requieren O&M programado para su mitigación, la hora de ejecución del O&M programado se determina por el intervalo de tiempo especificado en el parámetro TimePeriod. Cuando llega la hora de ejecución de un evento de O&M, la plataforma realiza automáticamente las operaciones de O&M correspondientes según el tipo de evento.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ecs:CreatePlanMaintenanceWindow

create

*Todos los recursos.

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PlanWindowName	string	Sí	El nombre de la ventana de O&M. Puede personalizar el nombre. El nombre puede tener una longitud de hasta 200 caracteres.	WIndowName
Enable	boolean	Sí	Especifica si se debe habilitar o deshabilitar la ventana. true: Habilitado. false: Deshabilitado.	true
SupportMaintenanceAction	string	Sí	Las operaciones de O&M que admite la ventana de O&M. Valores válidos: Redeploy : Redespliegue. PerformanceImpact : Impacto en el rendimiento. Reboot : Reinicio.	Reboot
RegionId	string	Sí	El ID de la región. Este parámetro es obligatorio para el enrutamiento del SDK de Alibaba Cloud. Sin embargo, especificar cualquier ID de región para esta operación produce el mismo resultado. La ventana de O&M se aplica a todas las instancias de ECS en la red que cumplen con las condiciones de filtrado de recursos.	cn-hangzhou
TimePeriod	object	Sí	El ciclo de recurrencia de la ventana.
PeriodUnit	string	Sí	El tipo de ciclo. Valores válidos: Daily y Weekly. Valores válidos: Daily : Daily. Weekly : Weekly.	Weekly
RangeList	array<object>	Sí	Los intervalos de tiempo del ciclo de recurrencia de la ventana de O&M en UTC.
	object	No	El elemento del intervalo de tiempo.
StartTime	string	No	La hora de inicio de la ventana de O&M. Si PeriodUnit se establece en Weekly, el formato es Monday,22:00. Monday se puede reemplazar con Tuesday, Wednesday, Thursday, Friday, Saturday o Sunday. Si PeriodUnit se establece en Daily, el formato es 22:00. La coma (,) se utiliza como separador. La primera parte representa la hora, con valores válidos de 00 a 23. La segunda parte representa el minuto. Actualmente, solo se admite 00.	Monday,22:00
EndTime	string	No	La hora de finalización de la ventana de O&M. Si PeriodUnit se establece en Weekly, el formato es Monday,22:00. Monday se puede reemplazar con Tuesday, Wednesday, Thursday, Friday, Saturday o Sunday. Si PeriodUnit se establece en Daily, el formato es 22:00. La coma (,) se utiliza como separador. La primera parte representa la hora, con valores válidos de 00 a 23. La segunda parte representa el minuto. Actualmente, solo se admite 00.	Tuesday,03:00
TargetResource	object	Sí	Los recursos a los que se aplica la ventana de O&M.
Scope	string	Sí	El tipo de recurso configurado para la ventana de O&M. Valores válidos: All : All. Tag : Tag. ResourceGroup : ResourceGroup.	Tag
ResourceGroupId	string	No	El ID del grupo de recursos. Este parámetro es obligatorio cuando Scope se establece en ResourceGroup.	rg-aekzhm7pmnvcbty
Tags	array<object>	No	Las etiquetas a las que se aplica la ventana de O&M. Este parámetro es obligatorio cuando Scope se establece en Tag.
	object	No	El valor de la etiqueta.
Key	string	No	La clave de la etiqueta a la que se aplica la ventana.	vms_qualification_Mr_Sun_ID_card_e5590864-1fef-4db2-b2a7-bd2d657fed43.png
Value	string	No	El valor de la etiqueta a la que se aplica la ventana.	21.137.18.60
MinMaintenanceInterval	integer	No

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud.	7D5B1188-3F08-56D1-A6B2-91B267452633
PlanWindowId	string	El ID de la ventana de O&M creada.	pw-bp1a9yavgq3dgttvowun

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidOperation.TooManyMaintenanceWindows	Too many maintenance windows.	El número de configuraciones de ventana de mantenimiento excede 200. No se pueden crear más ventanas.
500	InternalError	Internal error.	Se produjo un error interno. Vuelva a intentarlo.
403	AccessForbidden	User not authorized to operate on the specified resource.	No tiene autorización para usar el recurso especificado.
403	MissingParameter.Period	The input parameter Period is missing.	Falta el parámetro Period.
403	MissingParameter.TargetType	The input parameter TargetType is missing.	Falta el parámetro TargetType.
403	InvalidParameter.TimePeriod	Invalid Parameter Time Period.	La propiedad Time Period está configurada incorrectamente.
403	InvalidParameter.TargetResource	Invalid Parameter Target Resource.	La propiedad TargetResource está configurada incorrectamente.
403	InvalidParameter.SupportMaintenanceAction	Invalid Parameter SupportMaintenanceAction.	La propiedad SupportMaintenanceAction está configurada incorrectamente.
403	InvalidParameter.MinMaintenanceInterval	Invalid Parameter MinMaintenanceInterval.	El parámetro MinMaintenanceInterval está configurado incorrectamente.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.