ModifySqlLogConfig - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Ativa ou configura o DAS Enterprise Edition para uma instância de banco de dados.

Descrição da operação

Para usar esta operação, os seguintes pré-requisitos devem ser atendidos:

Use a versão mais recente do SDK do Alibaba Cloud ou do DAS.
Ao chamar o serviço DAS usando o SDK, defina a região como cn-shanghai.
Por padrão, esta operação ativa a versão suportada mais recente. Para os bancos de dados e regiões suportados por cada versão do DAS Enterprise Edition, consulte Edições do DAS e recursos suportados.

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

hdm:ModifySqlLogConfig

update

*All resources.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância de banco de dados.	rr-2ze770smbq3tp****
Enable	boolean	Não	Especifica se o DAS Enterprise Edition deve ser ativado. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é obrigatório quando você ativa o DAS Enterprise Edition. Por padrão, a versão suportada mais recente é ativada.	true
RequestEnable	boolean	Não	Especifica se o SQL Explorer deve ser ativado. Valores válidos: true: Sim. false: Não. Nota Este parâmetro é obrigatório apenas quando você ativa o DAS Enterprise Edition V3.	true
Retention	integer	Não	A duração total de armazenamento de dados. Unidade: dias. Valores válidos: 7 30 180 365 Nota Quando você ativa o DAS Enterprise Edition V3, o valor deste parâmetro deve ser maior ou igual a 30.	30
HotRetention	integer	Não	A duração de armazenamento de dados quentes. Unidade: dias. O valor é um número inteiro no intervalo de [1, 7]. Nota Este parâmetro é obrigatório apenas quando você ativa o DAS Enterprise Edition V3.	1
Filters	array<object>	Não	Um parâmetro reservado.
	object	Não	Um parâmetro reservado.
Key	string	Não	Um parâmetro reservado.	None
Value	string	Não	Um parâmetro reservado.	None
EnableAudit	boolean	Não	Especifica se a auditoria de segurança deve ser ativada.	true

O DAS Enterprise Edition possui quatro versões: V0, V1, V2 e V3. Por padrão, a versão suportada mais recente é ativada.

Para instâncias de banco de dados que suportam apenas o DAS Enterprise Edition V0, você só precisa especificar os parâmetros Enable e Retention.
Para instâncias de banco de dados que suportam o DAS Enterprise Edition V1, você só precisa especificar os parâmetros Enable e Retention. O sistema ativa automaticamente o recurso SQL Explorer (ou seja, as configurações padrão definem RequestEnable como true).
Para instâncias de banco de dados que suportam o DAS Enterprise Edition V2, você só precisa especificar os parâmetros Enable e Retention. O sistema ativa automaticamente o recurso SQL Explorer (ou seja, as configurações padrão definem RequestEnable como true), define a duração de armazenamento quente (HotRetention) como 7 dias e define a duração de armazenamento frio como Retention - 7 dias.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status retornado.	200
Message	string	A mensagem retornada. Nota Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, uma mensagem de erro, como um código de erro, será retornada.	Successful
RequestId	string	O ID da solicitação.	03C88D8E-1541-518E-8BFF-BEC6589B6334
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	false
Data	object	Os dados retornados.
SqlLogVisibleTime	integer	A hora em que o DAS Enterprise Edition foi ativado. A hora está no formato de carimbo de data/hora UNIX. Unidade: milissegundos.	1683712800000
RequestStopTime	integer	A hora de expiração do DAS Enterprise Edition V1. A hora está no formato de carimbo de data/hora UNIX. Unidade: milissegundos.	1715335200000
CollectorVersion	string	A versão do coletor. Valores válidos: MYSQL_V0: MySQL V0. MYSQL_V1: MySQL V1. MYSQL_V2: MySQL V2. MYSQL_V3: MySQL V3. PG_V1: PostgreSQL V1. rdspg_v1: ApsaraDB RDS for PostgreSQL V1. polarpg_v1: PolarDB for PostgreSQL V1.	MYSQL_V3
SupportVersion	string	A versão mais recente suportada do DAS Enterprise Edition. Valores válidos: SQL_LOG_V0: DAS Enterprise Edition V0. SQL_LOG_V1: DAS Enterprise Edition V1. SQL_LOG_V2: DAS Enterprise Edition V2. SQL_LOG_V3: DAS Enterprise Edition V3. SQL_LOG_NOT_ENABLE: O DAS Enterprise Edition não está ativado. SQL_LOG_NOT_SUPPORT: O DAS Enterprise Edition não é suportado.	SQL_LOG_V3
ColdRetention	integer	A duração de armazenamento de dados frios. Unidade: dias. O valor é calculado usando a fórmula: `Retention - HotRetention`.	23
SqlLogEnable	boolean	Indica se o DAS Enterprise Edition está ativado. Valores válidos: true: Sim. false: Não.	true
Retention	integer	A duração total de armazenamento de dados. Unidade: dias.	30
HotRetention	integer	A duração de armazenamento de dados quentes. Unidade: dias.	7
RequestEnable	boolean	Indica se o SQL Explorer está ativado. Valores válidos: true: Sim. false: Não.	false
Version	string	A versão ativada do DAS Enterprise Edition. Valores válidos: SQL_LOG_V0: DAS Enterprise Edition V0. SQL_LOG_V1: DAS Enterprise Edition V1. SQL_LOG_V2: DAS Enterprise Edition V2. SQL_LOG_V3: DAS Enterprise Edition V3. SQL_LOG_NOT_ENABLE: O DAS Enterprise Edition não está ativado. SQL_LOG_NOT_SUPPORT: O DAS Enterprise Edition não é suportado.	SQL_LOG_V3
RequestStartTime	integer	A hora em que o SQL Explorer foi ativado. A hora está no formato de carimbo de data/hora UNIX. Unidade: milissegundos.	1683712800000
HotEnable	boolean	Indica se o armazenamento de dados quentes está ativado. Valores válidos: true: Sim. false: Não.	true
HotStartTime	integer	A hora de início do armazenamento de dados quentes. A hora está no formato de carimbo de data/hora UNIX. Unidade: milissegundos.	1683712800000
ColdEnable	boolean	Indica se o armazenamento de dados frios está ativado. Valores válidos: true: Sim. false: Não.	true
ColdStartTime	integer	A hora de início do armazenamento de dados frios. A hora está no formato de carimbo de data/hora UNIX. Unidade: milissegundos.	1683712800000
SqlLogState	string	O status de migração de dados. Valores válidos: FINISH: A migração de dados históricos foi concluída. RUNNING: A migração de dados históricos está em andamento. FAILURE: A migração de dados históricos falhou.	FINISH
LogFilter	string	Um parâmetro reservado.	None
SqlLogSource	string	A origem dos logs de auditoria ativados.	DSC:DAS_SIDE

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "03C88D8E-1541-518E-8BFF-BEC6589B6334",
  "Success": "false",
  "Data": {
    "SqlLogVisibleTime": 1683712800000,
    "RequestStopTime": 1715335200000,
    "CollectorVersion": "MYSQL_V3",
    "SupportVersion": "SQL_LOG_V3",
    "ColdRetention": 23,
    "SqlLogEnable": true,
    "Retention": 30,
    "HotRetention": 7,
    "RequestEnable": false,
    "Version": "SQL_LOG_V3",
    "RequestStartTime": 1683712800000,
    "HotEnable": true,
    "HotStartTime": 1683712800000,
    "ColdEnable": true,
    "ColdStartTime": 1683712800000,
    "SqlLogState": "FINISH",
    "LogFilter": "None",
    "SqlLogSource": "DSC:DAS_SIDE"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidParams	The request parameters are invalid.	Os parâmetros da solicitação são inválidos.
403	NoPermission	You are not authorized to do this action.	Você não tem permissão para realizar esta operação.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.