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

Modifica as configurações do serviço 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 de configuração do serviço. Valores válidos: SessionManagerDelivery: entrega de logs de operação de sessão. InvocationDelivery: entrega de logs de execução de tarefa. AgentUpgradeConfig: configuração de atualização do Agente do Cloud Assistant. SessionManagerConfig: configuração do SessionManager do Cloud Assistant.	SessionManagerDelivery
OssDeliveryConfig	object	Não	A configuração de entrega do OSS.
BucketName	string	Não	O nome do bucket do OSS.	example-bucket
Enabled	boolean	Não	Especifica se a entrega para o OSS deve ser ativada. Valor padrão: false.	false
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 o método de criptografia é definido como KMS.	a807****7a70e
EncryptionType	string	Não	O método de criptografia do OSS. Valores válidos: Inherit: Herda o método de criptografia do bucket. OssManaged: Usa a criptografia gerenciada pelo OSS. KMS: Usa a criptografia baseada em KMS.	Inherit
Prefix	string	Não	O prefixo de diretório do bucket do OSS. Restrições: O prefixo não pode exceder 254 caracteres de comprimento. O prefixo não pode começar com uma barra (/) ou uma barra invertida (\). Nota Nota: Passe uma string vazia ("") para indicar que nenhum prefixo de diretório é necessário. Se um prefixo foi definido anteriormente e não é mais necessário, passe uma string vazia ("") para limpá-lo.	sessionmanager/audit
SlsDeliveryConfig	object	Não	A configuração de entrega do Simple Log Service (SLS).
Enabled	boolean	Não	Especifica se a entrega para o SLS deve ser ativada. Valor padrão: false.	false
LogstoreName	string	Não	O nome do Logstore do SLS.	example-logstore
ProjectName	string	Não	O nome do projeto do SLS.	example-project
AgentUpgradeConfig	object	Não	A configuração de atualização do Agente do Cloud Assistant.
AllowedUpgradeWindow	array	Não	A lista de janelas de tempo durante as quais as atualizações são permitidas. O tempo pode ser especificado até o minuto. O fuso horário padrão é UTC. O intervalo entre as janelas de tempo não pode ser inferior a 1 hora. Formato: hora de início (HH:mm)-hora de término (HH:mm). Por exemplo, [ "02:00-03:00", "05:00-06:00" ] indica que as atualizações são permitidas diariamente das 02:00 às 03:00 e das 05:00 às 06:00 no fuso horário UTC.
	string	Não	A lista de janelas de tempo durante as quais as atualizações são permitidas. O tempo pode ser especificado até o minuto. O fuso horário padrão é UTC. O intervalo entre as janelas de tempo não pode ser inferior a 1 hora. Formato: hora de início (HH:mm)-hora de término (HH:mm). Por exemplo, [ "02:00-03:00", "05:00-06:00" ] indica que as atualizações são permitidas diariamente das 02:00 às 03:00 e das 05:00 às 06:00 no fuso horário UTC.	[ "02:00-03:00", "05:00-06:00" ]
BootstrapUpgrade	boolean	Não	Especifica se o Agente do Cloud Assistant verifica atualizações de versão e realiza atualizações imediatamente após a inicialização. Valor padrão: true. Esta configuração entra em vigor apenas quando a versão do Agente do Cloud Assistant não é anterior às seguintes versões: Windows: 2.1.4.1065 Linux: 2.2.4.1065	true
DisableUpgrade	boolean	Não	Especifica se deve impedir que o Agente do Cloud Assistant verifique e realize atualizações. Valor padrão: false. Esta configuração entra em vigor apenas quando a versão do Agente do Cloud Assistant não é anterior às seguintes versões: Windows: 2.1.4.1065 Linux: 2.2.4.1065	false
Enabled	boolean	Não	Especifica se a configuração personalizada de atualização do Agente deve ser ativada. Se definido como false, o comportamento padrão de tentar uma atualização a cada 30 minutos é mantido. Valor padrão: false.	true
TimeZone	string	Não	O fuso horário para as janelas de tempo de atualização permitidas. O fuso horário padrão é UTC. O fuso horário pode ser especificado nos dois formatos a seguir: Nome completo do fuso horário: como Asia/Shanghai ou America/Los_Angeles. Deslocamento GMT em relação ao Horário de Greenwich: como GMT+8:00 ou GMT-7:00. Zeros à esquerda não são suportados para o valor da hora.	Asia/Shanghai
ResourceUsageConfig	object	Não	A configuração de uso de recursos do Cloud Assistant. Esta configuração entra em vigor apenas quando a versão do Agente do Cloud Assistant não é 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: porcentagem. Valores válidos: 10 a 95. Valor padrão: 20.	20
KeepScriptFile	boolean	Não	Especifica se o arquivo de script deve ser retido no diretório do Cloud Assistant após a conclusão da execução do comando. Valor padrão: false.	false
LogFileCountLimit	integer	Não	O número máximo de arquivos de log do Cloud Assistant a serem retidos. Valor padrão: 30. Valor mínimo: 7. Valor máximo: 365.	30
LogSizeLimit	string	Não	O limite de tamanho de um único arquivo de log do Cloud Assistant. Você deve especificar a unidade (B\|KB\|MB). Valor padrão: 100MB. Valor mínimo: 10MB. Valor máximo: 1024MB.	10MB
MemoryLimit	string	Não	O uso máximo de memória permitido para o processo principal do Agente do Cloud Assistant. Você deve especificar a unidade (B\|KB\|MB). Valor padrão: 50MB. Valor mínimo: 35MB. Valor máximo: 1024MB.	50MB
OverloadLimit	integer	Não	O número máximo de vezes consecutivas que o uso de recursos de CPU ou memória pode exceder o limite. Quando esse limite é atingido, o Agente do Cloud Assistant para de ser executado automaticamente. Valor padrão: 3. Valor mínimo: 3.	3
SessionManagerConfig	object	Não	A configuração do recurso de sessão do Cloud Assistant.
SessionManagerEnabled	boolean	Não	Especifica se o recurso de sessão do Cloud Assistant deve ser ativado. Valores válidos: true: Ativado. false: Desativado. Precauções: A ativação ou desativação do recurso de sessão entra em vigor em 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.	O parâmetro SettingType especificado é inválido.
400	InvalidParameter.OssEncryptionType	The specified parameter OssDeliveryConfig.EncryptionType is not valid.	O parâmetro OssDeliveryConfig.EncryptionType especificado é inválido.
400	InvalidParameter.OssEncryptionAlgorithm	The specified parameter OssDeliveryConfig.EncryptionAlgorithm is not valid.	O parâmetro OssDeliveryConfig.EncryptionAlgorithm especificado é inválido.
400	InvalidParameter.OssEncryptionKeyId	The specified parameter OssDeliveryConfig.EncryptionKeyId is not valid.	O parâmetro OssDeliveryConfig.EncryptionKeyId especificado é inválido.
400	InvalidParameter.OssBucketName	The specified parameter OssDeliveryConfig.BucketName is not valid.	O parâmetro OssDeliveryConfig.BucketName especificado é inválido.
400	InvalidParameter.OssPrefix	The specified parameter OssDeliveryConfig.Prefix is not valid.	O parâmetro OssDeliveryConfig.Prefix especificado é inválido.
400	InvalidOssBucketName.InOtherRegion	The specified parameter OssDeliveryConfig.BucketName is in another region.	O bucket do OSS especificado por OssDeliveryConfig.BucketName está em uma região diferente.
400	InvalidParameter.SlsProjectName	The specified parameter SlsDeliveryConfig.ProjectName is not valid.	O parâmetro SlsDeliveryConfig.ProjectName especificado é inválido.
400	InvalidParameter.SlsLogstoreName	The specified parameter SlsDeliveryConfig.LogstoreName is not valid.	O parâmetro SlsDeliveryConfig.LogstoreName especificado é inválido.
400	InvalidParameter.AllowedUpgradeWindow	The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is not valid.	O parâmetro AgentUpgradeConfig.AllowedUpgradeWindow especificado é inválido.
400	InvalidAllowedUpgradeWindow.DurationTooShort	The duration of the specified parameter AgentUpgradeConfig.AllowedUpgradeWindow cannot be less than one hour.	O intervalo do parâmetro AllowedUpgradeWindow não pode ser inferior a meia hora.
400	InvalidParameter.TimeZone	The specified parameter AgentUpgradeConfig.TimeZone is not valid.	O parâmetro AgentUpgradeConfig.TimeZone especificado é inválido.
400	InvalidAllowedUpgradeWindow.Required	The specified parameter AgentUpgradeConfig.AllowedUpgradeWindow is required.	Ao ativar o parâmetro de configuração de atualização personalizada do agente, AgentUpgradeConfig.AllowedUpgradeWindow é obrigatório.
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.	Ocorreu um erro interno. Tente novamente.
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.	Você não tem permissão para criar funções vinculadas ao serviço.
403	InvalidOperation.OssEncryptionUnsupported	The configuration of OSS Encryption is not supported.	O serviço atual não oferece suporte à definição do método de criptografia do OSS.
403	InvalidAllowedUpgradeWindow.CountLimitExceeded	The count of the parameter AgentUpgradeConfig.AllowedUpgradeWindow exceeds the limit of 5.	O número de parâmetros AgentUpgradeConfig.AllowedUpgradeWindow excede o limite de 5.
403	InvalidOperation.SessionManagerDeliveryUnsupported	The delivery configuration of Session Manager is not supported.	A ativação da configuração de entrega do Session Manager não é suportada.
403	InvalidDisableUpgrade.Conflict	The parameter DisableUpgrade cannot be specified with parameter BootstrapUpgrade.
404	InvalidSlsProjectName.NotFound	The specified parameter SlsDeliveryConfig.ProjectName does not exist.	O projeto do Simple Log Service (SLS) especificado não existe.
404	InvalidSlsLogstoreName.NotFound	The specified parameter SlsDeliveryConfig.LogstoreName does not exist.	O Logstore do Simple Log Service (SLS) especificado não existe.
404	InvalidOssBucketName.NotFound	The specified parameter OssDeliveryConfig.BucketName does not exist.	O bucket do OSS especificado não existe.
404	InvalidRegionId.NotFound	The specified parameter RegionId does not exist.	O RegionId especificado não existe. Verifique se o produto está disponível nesta região.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.