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

Visão geral da configuração 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	Os tipos de configurações de serviço a serem consultadas.
	string	Não	Um tipo de configuração de serviço. Valores válidos: SessionManagerDelivery: Controla a entrega de registros de operação de sessão. InvocationDelivery: Controla a entrega de registros de execução de comandos. AgentUpgradeConfig: Controla as atualizações do agente do Cloud Assistant. SessionManagerConfig: Controla as configurações 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
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
OssDeliveryConfigs	object
OssDeliveryConfig	array<object>	Uma lista de configurações de entrega do OSS.
	object	Uma configuração de entrega do OSS.
EncryptionType	string	The OSS encryption method. Valid values: `Inherit`: Inherits the encryption settings from the bucket. `OssManaged`: Data is encrypted using a key that is fully managed by OSS. `KMS`: Data is encrypted using a KMS key.	Inherit
EncryptionAlgorithm	string	The OSS encryption algorithm. Valid values: AES256 SM4	AES256
DeliveryType	string	The type of logs to deliver. Valid values: `SessionManager`: Session Manager records. `Invocation`: invocation records.	SessionManager
Enabled	boolean	Indicates whether delivery to OSS is enabled.	false
BucketName	string	The name of the OSS bucket.	example-bucket
Prefix	string	The directory prefix in the OSS bucket.	sessionmanager/audit
EncryptionKeyId	string	The ID of the Customer Master Key (CMK) used when `EncryptionType` is set to `KMS`.	a807****7a70e
SlsDeliveryConfigs	object
SlsDeliveryConfig	array<object>	Uma lista de configurações de entrega do SLS.
	object	A configuração de entrega do SLS.
DeliveryType	string	The type of logs to deliver. Valid values: `SessionManager`: Session Manager records. `Invocation`: invocation records.	SessionManager
LogstoreName	string	The name of the SLS Logstore.	example-logstore
Enabled	boolean	Indicates whether delivery to SLS is enabled.	false
ProjectName	string	The name of the SLS Project.	example-project
AgentUpgradeConfig	object	A configuração de atualização do agente do Cloud Assistant.
Enabled	boolean	Indica se as configurações personalizadas de atualização do agente estão ativadas. Se este parâmetro for `false` ou não for especificado, o agente tentará atualizar a cada 30 minutos por padrão.	true
AllowedUpgradeWindows	object
AllowedUpgradeWindow	array	The list of allowed upgrade windows.
	string	An allowed upgrade window.	[ "02:00-03:00", "05:00-06:00" ]
TimeZone	string	O fuso horário para as janelas de tempo permitidas para atualização.	Asia/Shanghai
BootstrapUpgrade	boolean	Indica se o agente do Cloud Assistant verifica e realiza uma atualização na inicialização.	true
DisableUpgrade	boolean	Indica se as atualizações automáticas do agente do Cloud Assistant devem ser desativadas.	true
ResourceUsageConfig	object	A configuração de uso de recursos do Cloud Assistant.
CpuLimit	integer	O limite máximo de uso de CPU para o processo principal do agente do Cloud Assistant.	20
MemoryLimit	string	O limite máximo de uso de memória para o processo principal do agente do Cloud Assistant.	35MB
OverloadLimit	integer	O número máximo de vezes consecutivas que o uso de CPU ou memória pode exceder os limites especificados. Se esse número for atingido, o agente do Cloud Assistant será interrompido.	3
LogFileCountLimit	integer	O número máximo de arquivos de log do Cloud Assistant a serem retidos.	30
LogSizeLimit	string	O limite de tamanho para cada arquivo de log do Cloud Assistant.	100MB
KeepScriptFile	boolean	Indica se o arquivo de script deve ser mantido no diretório do Cloud Assistant após a conclusão da execução do comando.	false
SessionManagerConfig	object	A configuração do Session Manager do Cloud Assistant.
SessionManagerEnabled	boolean	Indica se o Session Manager está ativado. Valores válidos: `true`: Ativado. `false`: Desativado. Nota: Esta configuração entra em vigor em todas as regiões.	true

Exemplos

Resposta de sucesso

JSON formato

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

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.	The specified parameter SettingType is illegal.
500	InternalError	An error occurred when you dispatched the request.	An error occurred while sending the request, please try again later.
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.