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

Consulta a configuração da DAS Enterprise Edition de uma instância de banco de dados.

Descrição da operação

Antes de começar:

Use a versão mais recente do SDK do Alibaba Cloud ou do DAS.
Ao chamar o DAS usando o SDK, defina a região como cn-shanghai.

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

get

*Todos os recursos.

*

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.	rm-2ze8g2am97624****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status retornado.	200
Data	object	Os dados retornados.
ColdEnable	boolean	Indica se o armazenamento de dados frios está ativado. Valores válidos: true: Ativado. false: Não ativado.	true
ColdRetention	integer	A duração do armazenamento de dados frios. Unidade: dias.	23
ColdStartTime	integer	A hora de início do armazenamento de dados frios. O valor é um timestamp UNIX. Unidade: milissegundos.	1683712800000
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: RDS PostgreSQL V1. polarpg_v1: PolarDB for PostgreSQL V1.	MYSQL_V3
HotEnable	boolean	Indica se o armazenamento de dados quentes está ativado. Valores válidos: true: Ativado. false: Não ativado.	true
HotRetention	integer	A duração do armazenamento de dados quentes. Unidade: dias.	7
HotStartTime	integer	A hora de início do armazenamento de dados quentes. O valor é um timestamp UNIX. Unidade: milissegundos.	1683712800000
LogFilter	string	Um parâmetro reservado.	None
RequestEnable	boolean	Indica se o SQL Explorer está ativado. Valores válidos: true: Ativado. false: Não ativado.	true
RequestStartTime	integer	A hora em que o SQL Explorer foi ativado. O valor é um timestamp UNIX. Unidade: milissegundos.	1683712800000
RequestStopTime	integer	A hora de expiração da DAS Enterprise Edition V1. O valor é um timestamp UNIX. Unidade: milissegundos.	1715335200000
Retention	integer	A duração total do armazenamento de dados, que é a soma de HotRetention e ColdRetention. Unidade: dias.	30
SqlLogEnable	boolean	Indica se a DAS Enterprise Edition está ativada. Valores válidos: true: Ativado. false: Não ativado.	true
Enable	boolean	Indica se o SQL Explorer está ativado. Este parâmetro é um alias de SqlLogEnable.
SqlLogSource	string	Um parâmetro reservado.	None
SqlLogState	string	O status da 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
SqlLogVisibleTime	integer	A hora em que a DAS Enterprise Edition foi ativada. O valor é um timestamp UNIX. Unidade: milissegundos.	1683712800000
SupportMigration	boolean	Um parâmetro reservado.	None
SupportVersion	string	A versão mais recente da DAS Enterprise Edition suportada pela instância atual. Valores válidos: SQL_LOG_V0: Enterprise Edition V0. SQL_LOG_V1: Enterprise Edition V1. SQL_LOG_V2: Enterprise Edition V2. SQL_LOG_V3: Enterprise Edition V3. SQL_LOG_NOT_ENABLE: A Enterprise Edition não está ativada. SQL_LOG_NOT_SUPPORT: A Enterprise Edition não é suportada.	SQL_LOG_V3
SupportSecurityAudit	boolean	Indica se o mecanismo e a região da instância atual suportam a ativação da auditoria de segurança. Este campo indica apenas a capacidade do produto e não indica que a auditoria de segurança já está ativada.
Version	string	A versão atual da DAS Enterprise Edition que está ativada. Valores válidos: SQL_LOG_V0: Enterprise Edition V0. SQL_LOG_V1: Enterprise Edition V1. SQL_LOG_V2: Enterprise Edition V2. SQL_LOG_V3: Enterprise Edition V3. SQL_LOG_NOT_ENABLE: A Enterprise Edition não está ativada. SQL_LOG_NOT_SUPPORT: A Enterprise Edition não é suportada.	SQL_LOG_V3
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 será retornada, como um código de erro.	Successful
RequestId	string	O ID da solicitação.	0A74B755-98B7-59DB-8724-1321B394****
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.	true

Para SQL_LOG_V0 (Enterprise Edition V0) e SQL_LOG_V1 (Enterprise Edition V1), os dados são armazenados no CStore e são considerados armazenamento quente. Para instâncias de banco de dados com essas versões ativadas, a consulta retorna SqlLogEnable = HotEnable = true, Retention = HotRetention, ColdEnable = false, ColdRetention = 0.

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Data": {
    "ColdEnable": true,
    "ColdRetention": 23,
    "ColdStartTime": 1683712800000,
    "CollectorVersion": "MYSQL_V3",
    "HotEnable": true,
    "HotRetention": 7,
    "HotStartTime": 1683712800000,
    "LogFilter": "None",
    "RequestEnable": true,
    "RequestStartTime": 1683712800000,
    "RequestStopTime": 1715335200000,
    "Retention": 30,
    "SqlLogEnable": true,
    "Enable": false,
    "SqlLogSource": "None",
    "SqlLogState": "FINISH",
    "SqlLogVisibleTime": 1683712800000,
    "SupportMigration": true,
    "SupportVersion": "SQL_LOG_V3",
    "SupportSecurityAudit": false,
    "Version": "SQL_LOG_V3"
  },
  "Message": "Successful",
  "RequestId": "0A74B755-98B7-59DB-8724-1321B394****",
  "Success": "true"
}

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 as permissões para realizar esta operação.
404	InstanceNotFound	The specified instance does not exist.	A instância não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.