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

Consulta 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:DescribeCloudAssistantSettings

list

*ServiceSettings.

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SettingType	array	Sim	A lista de configurações de serviço a serem consultadas.
	string	Não	O tipo de configuração de serviço a ser consultada. 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
RegionId	string	Sim	O ID da região.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
AgentUpgradeConfig	object	A configuração de atualização do Agente do Cloud Assistant.
AllowedUpgradeWindows	object
AllowedUpgradeWindow	array	A lista de janelas de tempo permitidas para atualização.
	string	A lista de janelas de tempo permitidas para atualização.	[ "02:00-03:00", "05:00-06:00" ]
BootstrapUpgrade	boolean	Indica se o Agente do Cloud Assistant verifica e realiza atualizações imediatamente após a inicialização.	true
DisableUpgrade	boolean	Indica se o Agente do Cloud Assistant está impedido de verificar e realizar atualizações.	true
Enabled	boolean	Indica se a configuração personalizada de atualização do Agente está ativada. Se o resultado da consulta for falso ou vazio, o comportamento padrão de tentar uma atualização a cada 30 minutos é mantido.	true
TimeZone	string	O fuso horário das janelas de tempo permitidas para atualização.	Asia/Shanghai
OssDeliveryConfigs	object
OssDeliveryConfig	array<object>	A lista de configurações de entrega do OSS.
	object	As informações de configuração de entrega do OSS.
BucketName	string	O nome do bucket do OSS.	example-bucket
DeliveryType	string	O tipo de entrega. Valores válidos: SessionManager: logs de operação de sessão. Invocation: logs de execução de tarefa.	SessionManager
Enabled	boolean	Indica se a entrega para o OSS está ativada.	false
EncryptionAlgorithm	string	O algoritmo de criptografia do OSS. Valores válidos: AES256 SM4	AES256
EncryptionKeyId	string	O ID da chave mestra do cliente (CMK) usada quando o método de criptografia é KMS.	a807****7a70e
EncryptionType	string	O método de criptografia do OSS. Valores válidos: Inherit: herdado do bucket. OssManaged: totalmente gerenciado pelo OSS. KMS: criptografia KMS.	Inherit
Prefix	string	O prefixo do diretório do bucket do OSS.	sessionmanager/audit
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ResourceUsageConfig	object	A configuração de uso de recursos do Cloud Assistant.
CpuLimit	integer	O uso máximo de CPU permitido para o processo principal do Agente do Cloud Assistant.	20
KeepScriptFile	boolean	Indica se o arquivo de script é mantido no diretório do Cloud Assistant após a conclusão da execução do comando.	false
LogFileCountLimit	integer	O número máximo de arquivos de log do Cloud Assistant a serem mantidos.	30
LogSizeLimit	string	O limite de tamanho dos arquivos de log do Cloud Assistant.	100MB
MemoryLimit	string	O uso máximo de memória permitido para o processo principal do Agente do Cloud Assistant.	35MB
OverloadLimit	integer	O número máximo de vezes consecutivas que o uso de recursos de CPU ou memória pode exceder o limite. Após esse limite ser atingido, o Agente do Cloud Assistant interrompe a execução automaticamente.	3
SessionManagerConfig	object	A configuração do recurso de sessão do Cloud Assistant.
SessionManagerEnabled	boolean	O seletor para o recurso de sessão do Cloud Assistant. 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
SlsDeliveryConfigs	object
SlsDeliveryConfig	array<object>	A lista de configurações de entrega do SLS.
	object	As informações de configuração de entrega do SLS.
DeliveryType	string	O tipo de entrega. Valores válidos: SessionManager: logs de operação de sessão. Invocation: logs de execução de tarefa.	SessionManager
Enabled	boolean	Indica se a entrega para o SLS está ativada.	false
LogstoreName	string	O nome do Logstore do SLS.	example-logstore
ProjectName	string	O nome do projeto do SLS.	example-project

Exemplos

Resposta de sucesso

JSON formato

{
  "AgentUpgradeConfig": {
    "AllowedUpgradeWindows": {
      "AllowedUpgradeWindow": [
        "[\n\"02:00-03:00\",\n\"05:00-06:00\"\n]"
      ]
    },
    "BootstrapUpgrade": true,
    "DisableUpgrade": true,
    "Enabled": true,
    "TimeZone": "Asia/Shanghai"
  },
  "OssDeliveryConfigs": {
    "OssDeliveryConfig": [
      {
        "BucketName": "example-bucket",
        "DeliveryType": "SessionManager",
        "Enabled": false,
        "EncryptionAlgorithm": "AES256",
        "EncryptionKeyId": "a807****7a70e",
        "EncryptionType": "Inherit",
        "Prefix": "sessionmanager/audit"
      }
    ]
  },
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ResourceUsageConfig": {
    "CpuLimit": 20,
    "KeepScriptFile": false,
    "LogFileCountLimit": 30,
    "LogSizeLimit": "100MB",
    "MemoryLimit": "35MB",
    "OverloadLimit": 3
  },
  "SessionManagerConfig": {
    "SessionManagerEnabled": true
  },
  "SlsDeliveryConfigs": {
    "SlsDeliveryConfig": [
      {
        "DeliveryType": "SessionManager",
        "Enabled": false,
        "LogstoreName": "example-logstore",
        "ProjectName": "example-project"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParameter.SettingType	The specified parameter SettingType is not valid.	O parâmetro SettingType especificado é inválido.
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.
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.