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

Modifica as configurações do Cloud Assistant.

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

update

*ServiceSettings

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região.	cn-hangzhou
SettingType	string	Sim	O tipo das configurações do serviço. Valores válidos: `SessionManagerDelivery`: as configurações de entrega de registros de sessão. `InvocationDelivery`: as configurações de entrega de registros de execução de comandos. `AgentUpgradeConfig`: as configurações de atualização do agente do Cloud Assistant. `SessionManagerConfig`: as configurações do Session Manager do Cloud Assistant.	SessionManagerDelivery
OssDeliveryConfig	object	Não	As configurações de entrega de registros para o OSS.
Enabled	boolean	Não	Especifica se o recurso de entrega de registros para o OSS deve ser ativado. Valor padrão: false.	false
BucketName	string	Não	O nome do bucket do OSS.	example-bucket
Prefix	string	Não	O prefixo do diretório no bucket do OSS. Os seguintes limites se aplicam: O prefixo pode ter até 254 caracteres de comprimento. O prefixo não pode começar com uma barra (/) ou uma barra invertida (). Nota: Se você deseja entregar registros no diretório raiz do bucket, insira "". Para limpar o prefixo definido anteriormente, insira "".	sessionmanager/audit
EncryptionType	string	Não	O modo de criptografia do OSS. Valores válidos: Inherit: herda a criptografia do bucket. OssManaged: usa a criptografia no lado do servidor gerenciada pelo OSS. KMS: usa a criptografia do KMS.	Inherit
EncryptionAlgorithm	string	Não	O algoritmo de criptografia do OSS. Valores válidos: AES256 SM4.	AES256
EncryptionKeyId	string	Não	O ID da chave mestra do cliente (CMK) quando a criptografia do KMS é usada.	a807****7a70e
SlsDeliveryConfig	object	Não	As configurações de entrega de registros para o SLS.
Enabled	boolean	Não	Especifica se o recurso de entrega de registros para o SLS deve ser ativado. Valor padrão: false.	false
ProjectName	string	Não	O nome do projeto do SLS.	example-project
LogstoreName	string	Não	O nome do Logstore do SLS.	example-logstore
AgentUpgradeConfig	object	Não	As configurações de atualização do agente do Cloud Assistant.
Enabled	boolean	Não	Especifica se as configurações personalizadas de atualização do agente devem ser ativadas. Se você definir este parâmetro como false, o agente tentará se atualizar a cada 30 minutos por padrão. Valor padrão: false.	true
AllowedUpgradeWindow	array	Não	Uma lista de janelas de tempo durante as quais o agente pode ser atualizado. As janelas de tempo têm precisão de minutos e estão em UTC por padrão. O intervalo entre duas janelas de tempo consecutivas deve ser de pelo menos 1 hora. Formato: StartTime(HH:mm)-EndTime(HH:mm). Por exemplo, [ "02:00-03:00", "05:00-06:00" ] indica que o agente pode ser atualizado das 2:00 às 3:00 e das 5:00 às 6:00 todos os dias em UTC.
	string	Não	Uma lista de janelas de tempo durante as quais o agente pode ser atualizado. As janelas de tempo têm precisão de minutos e estão em UTC por padrão. O intervalo entre duas janelas de tempo consecutivas deve ser de pelo menos 1 hora. Formato: StartTime(HH:mm)-EndTime(HH:mm). Por exemplo, [ "02:00-03:00", "05:00-06:00" ] indica que o agente pode ser atualizado das 2:00 às 3:00 e das 5:00 às 6:00 todos os dias em UTC.	[ "02:00-03:00", "05:00-06:00" ]
TimeZone	string	Não	O fuso horário das janelas de tempo para atualização do agente. Valor padrão: UTC. Os seguintes formatos são suportados para o fuso horário: Nome do fuso horário: por exemplo, Asia/Shanghai (hora da China/Xangai) e America/Los_Angeles (hora dos EUA/Los Angeles). Deslocamento em relação ao Horário de Greenwich (GMT): por exemplo, GMT+8:00 (UTC+8) e GMT-7:00 (UTC-7). A parte da hora não pode ter um zero à esquerda.	Asia/Shanghai
BootstrapUpgrade	boolean	Não	Especifica se a versão deve ser verificada imediatamente e uma atualização executada quando o agente do Cloud Assistant for iniciado. Valor padrão: true. Esta configuração entra em vigor apenas quando a versão do agente do Cloud Assistant não for anterior às seguintes versões: Windows: 2.1.4.1065 Linux: 2.2.4.1065.	true
DisableUpgrade	boolean	Não	Especifica se o agente do Cloud Assistant deve ser impedido de verificar ou executar atualizações. Valor padrão: false. Esta configuração entra em vigor apenas quando a versão do agente do Cloud Assistant não for anterior às seguintes versões: Windows: 2.1.4.1065 Linux: 2.2.4.1065.	false
ResourceUsageConfig	object	Não	As configurações de uso de recursos para o Cloud Assistant. Esta configuração entra em vigor apenas quando a versão do agente do Cloud Assistant não for anterior às seguintes versões: Windows: 2.1.4.1065 Linux: 2.2.4.1065.
CpuLimit	integer	Não	O uso máximo de CPU permitido para o processo principal do agente do Cloud Assistant. Unidade: %. Valores válidos: 10 a 95. Valor padrão: 20.	20
MemoryLimit	string	Não	O uso máximo de memória permitido para o processo principal do agente do Cloud Assistant. Você deve especificar uma unidade (B, KB ou MB). Valor padrão: 50 MB. Valor mínimo: 35 MB. Valor máximo: 1024 MB.	50MB
OverloadLimit	integer	Não	O número máximo de vezes consecutivas que o uso de CPU ou memória pode exceder os limites especificados. Se os limites forem excedidos consecutivamente pelo número de vezes especificado, o agente do Cloud Assistant será interrompido automaticamente. Valor padrão: 3. Valor mínimo: 3.	3
LogFileCountLimit	integer	Não	O número máximo de arquivos de log do Cloud Assistant que podem ser retidos. Valor padrão: 30. Valor mínimo: 7. Valor máximo: 365.	30
LogSizeLimit	string	Não	O tamanho máximo de um único arquivo de log do Cloud Assistant. Você deve especificar uma unidade (B, KB ou MB). Valor padrão: 100 MB. Valor mínimo: 10 MB. Valor máximo: 1024 MB.	10MB
KeepScriptFile	boolean	Não	Especifica se o arquivo de script de um comando deve ser retido no diretório do Cloud Assistant após a conclusão da execução do comando. Valor padrão: false.	false
SessionManagerConfig	object	Não	As configurações do recurso Session Manager.
SessionManagerEnabled	boolean	Não	A chave para o recurso Session Manager. Valores válidos: true: ativa o recurso. false: desativa o recurso. Nota: Depois de ativar ou desativar o recurso Session Manager, a configuração entra em vigor para todas as regiões.	true

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
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.	The specified parameter SettingType is illegal.
400	InvalidParameter.OssEncryptionType	The specified parameter OssDeliveryConfig.EncryptionType is not valid.	The specified parameter OssDeliveryConfig.EncryptionType is not valid.
400	InvalidParameter.OssEncryptionAlgorithm	The specified parameter OssDeliveryConfig.EncryptionAlgorithm is not valid.	The specified parameter OssDeliveryConfig.EncryptionAlgorithm is illegal.
400	InvalidParameter.OssEncryptionKeyId	The specified parameter OssDeliveryConfig.EncryptionKeyId is not valid.	The specified parameter OssDeliveryConfig.EncryptionKeyId is illegal.
400	InvalidParameter.OssBucketName	The specified parameter OssDeliveryConfig.BucketName is not valid.	The specified parameter OssDeliveryConfig.BucketName is illegal.
400	InvalidParameter.OssPrefix	The specified parameter OssDeliveryConfig.Prefix is not valid.
400	InvalidOssBucketName.InOtherRegion	The specified parameter OssDeliveryConfig.BucketName is in another region.	The OSS bucket corresponding to the specified parameter OssDeliveryConfig.BucketName is in another region.
400	InvalidParameter.SlsProjectName	The specified parameter SlsDeliveryConfig.ProjectName is not valid.
400	InvalidParameter.SlsLogstoreName	The specified parameter SlsDeliveryConfig.LogstoreName is not valid.
400	InvalidParameter.AllowedUpgradeWindow	The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is not valid.	The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is illegal.
400	InvalidAllowedUpgradeWindow.DurationTooShort	The duration of the specified parameter AgentUpgradeConfig.AllowedUpgradeWindow cannot be less than one hour.
400	InvalidParameter.TimeZone	The specified parameter AgentUpgradeConfig.TimeZone is not valid.
400	InvalidAllowedUpgradeWindow.Required	The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is required.
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.	An error occurred while sending the request, please try again later.
403	InvalidOssBucketName.AccessDenied	The error message returned by the OSS API is: %s
403	CreateServiceLinkedRole.NoPermission	You do not have permission to create ServiceLinkedRole.
403	InvalidOperation.OssEncryptionUnsupported	The configuration of OSS Encryption is not supported.	The current service does not support setting the OSS encryption mode.
403	InvalidAllowedUpgradeWindow.CountLimitExceeded	The count of the parameter AgentUpgradeConfig.AllowedUpgradeWindow exceeds the limit of 5.	The number of parameters AgentUpgradeConfig.AllowedUpgradeWindow exceeds the limit of 5.
403	InvalidOperation.SessionManagerDeliveryUnsupported	The delivery configuration of Session Manager is not supported.
403	InvalidDisableUpgrade.Conflict	The parameter DisableUpgrade cannot be specified with parameter BootstrapUpgrade.
404	InvalidSlsProjectName.NotFound	The specified parameter SlsDeliveryConfig.ProjectName does not exist.
404	InvalidSlsLogstoreName.NotFound	The specified parameter SlsDeliveryConfig.LogstoreName does not exist.
404	InvalidOssBucketName.NotFound	The specified parameter OssDeliveryConfig.BucketName does not exist.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.