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

Modifica las configuraciones del servicio Cloud Assistant.

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

update

*ServiceSettings.

acs:ecs:{#regionId}:{#accountId}:servicesettings/{#servicesettingId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región.	cn-hangzhou
SettingType	string	Sí	El tipo de configuración del servicio. Valores válidos: SessionManagerDelivery: entrega de registros de operaciones de sesión. InvocationDelivery: entrega de registros de ejecución de tareas. AgentUpgradeConfig: configuración de actualización del agente de Cloud Assistant. SessionManagerConfig: configuración de SessionManager de Cloud Assistant.	SessionManagerDelivery
OssDeliveryConfig	object	No	La configuración de entrega de OSS.
BucketName	string	No	El nombre del bucket de OSS.	example-bucket
Enabled	boolean	No	Especifica si se debe habilitar la entrega a OSS. Valor predeterminado: false.	false
EncryptionAlgorithm	string	No	El algoritmo de cifrado de OSS. Valores válidos: AES256 SM4	AES256
EncryptionKeyId	string	No	El ID de la clave maestra del cliente (CMK) cuando el método de cifrado se establece en KMS.	a807****7a70e
EncryptionType	string	No	El método de cifrado de OSS. Valores válidos: Inherit: hereda el método de cifrado del bucket. OssManaged: utiliza el cifrado administrado por OSS. KMS: utiliza el cifrado basado en KMS.	Inherit
Prefix	string	No	El prefijo de directorio del bucket de OSS. Restricciones: El prefijo no puede superar los 254 caracteres de longitud. El prefijo no puede comenzar con una barra diagonal (/) ni con una barra diagonal inversa (). Nota Nota: Pase una cadena vacía ("") para indicar que no se requiere ningún prefijo de directorio. Si se configuró previamente un prefijo y ya no es necesario, pase una cadena vacía ("") para borrarlo.	sessionmanager/audit
SlsDeliveryConfig	object	No	La configuración de entrega de Simple Log Service (SLS).
Enabled	boolean	No	Especifica si se debe habilitar la entrega a SLS. Valor predeterminado: false.	false
LogstoreName	string	No	El nombre del Logstore de SLS.	example-logstore
ProjectName	string	No	El nombre del proyecto de SLS.	example-project
AgentUpgradeConfig	object	No	La configuración de actualización del agente de Cloud Assistant.
AllowedUpgradeWindow	array	No	La lista de ventanas de tiempo durante las cuales se permiten las actualizaciones. La hora se puede especificar hasta el minuto. La zona horaria predeterminada es UTC. El intervalo entre las ventanas de tiempo no puede ser inferior a 1 hora. Formato: hora de inicio (HH:mm)-hora de fin (HH:mm). Por ejemplo, [ "02:00-03:00", "05:00-06:00" ] indica que las actualizaciones se permiten diariamente de 02:00 a 03:00 y de 05:00 a 06:00 en la zona horaria UTC.
	string	No	La lista de ventanas de tiempo durante las cuales se permiten las actualizaciones. La hora se puede especificar hasta el minuto. La zona horaria predeterminada es UTC. El intervalo entre las ventanas de tiempo no puede ser inferior a 1 hora. Formato: hora de inicio (HH:mm)-hora de fin (HH:mm). Por ejemplo, [ "02:00-03:00", "05:00-06:00" ] indica que las actualizaciones se permiten diariamente de 02:00 a 03:00 y de 05:00 a 06:00 en la zona horaria UTC.	[ "02:00-03:00", "05:00-06:00" ]
BootstrapUpgrade	boolean	No	Especifica si el agente de Cloud Assistant busca actualizaciones de versión y las realiza inmediatamente al iniciarse. Valor predeterminado: true. Esta configuración solo surte efecto cuando la versión del agente de Cloud Assistant no es anterior a las siguientes versiones: Windows: 2.1.4.1065 Linux: 2.2.4.1065	true
DisableUpgrade	boolean	No	Especifica si se debe impedir que el agente de Cloud Assistant busque y realice actualizaciones. Valor predeterminado: false. Esta configuración solo surte efecto cuando la versión del agente de Cloud Assistant no es anterior a las siguientes versiones: Windows: 2.1.4.1065 Linux: 2.2.4.1065	false
Enabled	boolean	No	Especifica si se debe habilitar la configuración de actualización personalizada del agente. Si se establece en false, se conserva el comportamiento predeterminado de intentar una actualización cada 30 minutos. Valor predeterminado: false.	true
TimeZone	string	No	La zona horaria para las ventanas de tiempo de actualización permitidas. La zona horaria predeterminada es UTC. La zona horaria se puede especificar en los siguientes dos formatos: Nombre completo de la zona horaria: como Asia/Shanghai o America/Los_Angeles. Desfase GMT respecto a la hora del meridiano de Greenwich: como GMT+8:00 o GMT-7:00. No se admiten ceros a la izquierda para el valor de la hora.	Asia/Shanghai
ResourceUsageConfig	object	No	La configuración de uso de recursos de Cloud Assistant. Esta configuración solo surte efecto cuando la versión del agente de Cloud Assistant no es anterior a las siguientes versiones: Windows: 2.1.4.1065 Linux: 2.2.4.1065
CpuLimit	integer	No	El uso máximo de CPU permitido para el proceso principal del agente de Cloud Assistant. Unidad: porcentaje. Valores válidos: de 10 a 95. Valor predeterminado: 20.	20
KeepScriptFile	boolean	No	Especifica si se debe conservar el archivo de script en el directorio de Cloud Assistant una vez completada la ejecución del comando. Valor predeterminado: false.	false
LogFileCountLimit	integer	No	El número máximo de archivos de registro de Cloud Assistant que se deben conservar. Valor predeterminado: 30. Valor mínimo: 7. Valor máximo: 365.	30
LogSizeLimit	string	No	El límite de tamaño de un solo archivo de registro de Cloud Assistant. Debe especificar la unidad (B\|KB\|MB). Valor predeterminado: 100MB. Valor mínimo: 10MB. Valor máximo: 1024MB.	10MB
MemoryLimit	string	No	El uso máximo de memoria permitido para el proceso principal del agente de Cloud Assistant. Debe especificar la unidad (B\|KB\|MB). Valor predeterminado: 50MB. Valor mínimo: 35MB. Valor máximo: 1024MB.	50MB
OverloadLimit	integer	No	El número máximo de veces consecutivas que el uso de recursos de CPU o memoria puede superar el límite. Cuando se alcanza este límite, el agente de Cloud Assistant detiene su ejecución automáticamente. Valor predeterminado: 3. Valor mínimo: 3.	3
SessionManagerConfig	object	No	La configuración de la función de sesión de Cloud Assistant.
SessionManagerEnabled	boolean	No	Especifica si se debe habilitar la función de sesión de Cloud Assistant. Valores válidos: true: habilitado. false: deshabilitado. Precauciones: Habilitar o deshabilitar la función de sesión surte efecto en todas las regiones.	true

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	ResourceBusy.SlrCreation	The ServiceLinkedRole is still being created or has not taken effect yet. Please try again later.
400	InvalidParameter.SettingType	The specified parameter SettingType is not valid.	El parámetro SettingType especificado no es válido.
400	InvalidParameter.OssEncryptionType	The specified parameter OssDeliveryConfig.EncryptionType is not valid.	El parámetro OssDeliveryConfig.EncryptionType especificado no es válido.
400	InvalidParameter.OssEncryptionAlgorithm	The specified parameter OssDeliveryConfig.EncryptionAlgorithm is not valid.	El parámetro OssDeliveryConfig.EncryptionAlgorithm especificado no es válido.
400	InvalidParameter.OssEncryptionKeyId	The specified parameter OssDeliveryConfig.EncryptionKeyId is not valid.	El parámetro OssDeliveryConfig.EncryptionKeyId especificado no es válido.
400	InvalidParameter.OssBucketName	The specified parameter OssDeliveryConfig.BucketName is not valid.	El parámetro OssDeliveryConfig.BucketName especificado no es válido.
400	InvalidParameter.OssPrefix	The specified parameter OssDeliveryConfig.Prefix is not valid.	El parámetro OssDeliveryConfig.Prefix especificado no es válido.
400	InvalidOssBucketName.InOtherRegion	The specified parameter OssDeliveryConfig.BucketName is in another region.	El bucket de OSS especificado por OssDeliveryConfig.BucketName se encuentra en una región diferente.
400	InvalidParameter.SlsProjectName	The specified parameter SlsDeliveryConfig.ProjectName is not valid.	El parámetro SlsDeliveryConfig.ProjectName especificado no es válido.
400	InvalidParameter.SlsLogstoreName	The specified parameter SlsDeliveryConfig.LogstoreName is not valid.	El parámetro SlsDeliveryConfig.LogstoreName especificado no es válido.
400	InvalidParameter.AllowedUpgradeWindow	The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is not valid.	El parámetro AgentUpgradeConfig.AllowedUpgradeWindow especificado no es válido.
400	InvalidAllowedUpgradeWindow.DurationTooShort	The duration of the specified parameter AgentUpgradeConfig.AllowedUpgradeWindow cannot be less than one hour.	El intervalo del parámetro AllowedUpgradeWindow no puede ser inferior a media hora.
400	InvalidParameter.TimeZone	The specified parameter AgentUpgradeConfig.TimeZone is not valid.	El parámetro AgentUpgradeConfig.TimeZone especificado no es válido.
400	InvalidAllowedUpgradeWindow.Required	The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is required.	Cuando habilita el parámetro de configuración de actualización personalizada del agente, AgentUpgradeConfig.AllowedUpgradeWindow es obligatorio.
400	InvalidParameter.CpuLimit	The specified parameter CpuLimit is not valid.
400	InvalidParameter.MemoryLimit	The specified parameter MemoryLimit is not valid.
400	InvalidParameter.OverloadLimit	The specified parameter OverloadLimit is not valid.
400	InvalidParameter.LogFileCountLimit	The specified parameter LogFileCountLimit is not valid.
400	InvalidParameter.LogSizeLimit	The specified parameter LogSizeLimit is not valid.
500	InternalError	An error occurred when you dispatched the request.	Ocurrió un error interno. Inténtelo de nuevo.
403	InvalidParameterCharacter	The specified parameter %s contains illegal characters.
403	InvalidOssBucketName.AccessDenied	The error message returned by the OSS API is: %s
403	CreateServiceLinkedRole.NoPermission	You do not have permission to create ServiceLinkedRole.	No tiene el permiso para crear roles vinculados al servicio.
403	InvalidOperation.OssEncryptionUnsupported	The configuration of OSS Encryption is not supported.	El servicio actual no admite la configuración del método de cifrado de OSS.
403	InvalidAllowedUpgradeWindow.CountLimitExceeded	The count of the parameter AgentUpgradeConfig.AllowedUpgradeWindow exceeds the limit of 5.	El número de parámetros AgentUpgradeConfig.AllowedUpgradeWindow supera el límite de 5.
403	InvalidOperation.SessionManagerDeliveryUnsupported	The delivery configuration of Session Manager is not supported.	No se admite habilitar la configuración de entrega de Session Manager.
403	InvalidDisableUpgrade.Conflict	The parameter DisableUpgrade cannot be specified with parameter BootstrapUpgrade.
404	InvalidSlsProjectName.NotFound	The specified parameter SlsDeliveryConfig.ProjectName does not exist.	El proyecto de SLS especificado no existe.
404	InvalidSlsLogstoreName.NotFound	The specified parameter SlsDeliveryConfig.LogstoreName does not exist.	El Logstore de SLS especificado no existe.
404	InvalidOssBucketName.NotFound	The specified parameter OssDeliveryConfig.BucketName does not exist.	El bucket de OSS especificado no existe.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.	El RegionId especificado no existe. Verifique si el producto está disponible en esta región.

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.