Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.

Central de ajuda> Document Database Service> Referência de API> APIs V3.0 (recomendada)> Consultas de informações de log> Configuração da auditoria do SQL

Atualizado em 2023-05-06 GMT+08:00

Ver PDF

Configuração da auditoria do SQL

Descrição

Essa API é usada para configurar uma política para registros de auditoria do SQL.

Restrições

Esta operação não pode ser executada em instâncias congeladas ou anormais.

Depuração

Você pode depurar essa API no API Explorer.

URI

Formato de URI
POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/auditlog-policy
Exemplo de URI
https://dds.ap-southeast-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/5cecca4c20e04146862651b8d385f26ain02/auditlog-policy

**Tabela 1** Parâmetros de solicitação
Nome	Tipo	IN	Obrigatório	Descrição
x-auth-token	string	header	Sim	Token do usuário
project_id	string	path	Sim	ID do projeto de um locatário em uma região. Para obter o ID do projeto, consulte Obtenção de um ID de projeto.
instance_id	string	path	Sim	ID da instância, que pode ser obtido chamando a API descrita em Consulta de instâncias e detalhes. Se você não tiver uma instância, chame a API descrita em Criação de uma instância de banco de dados para criar uma.

Solicitações

Descrição do parâmetro

**Tabela 2** Descrição do parâmetro
Nome	Tipo	Obrigatório	Descrição
keep_days	Integer	Sim	O número de dias para armazenar logs de auditoria. O valor pode ser 0 ou varia de 7 a 732. 0: indica que a auditoria do SQL está desativada. 7 a 732: indica os dias de retenção dos logs de auditoria após a habilitação da auditoria do SQL.
reserve_auditlogs	String	Não	Este parâmetro é válido somente quando a auditoria do SQL está desabilitada. true (valor padrão): indica que os logs de auditoria do histórico são retidos quando a auditoria do SQL é desabilitada. false: indica que os logs de auditoria históricos existentes são excluídos quando a auditoria do SQL é desativada.
audit_scope	String	Não	Este parâmetro só é válido quando a política de registo de auditoria está ativada. Se esse parâmetro for deixado em branco ou definido como all, todas as políticas de log de auditoria serão ativadas por padrão. Âmbito da auditoria: insira o nome do banco de dados ou da coleção. Use vírgulas (,) para separar vários bancos de dados ou coleções. Se o nome contiver uma vírgula (,), adicione um cifrão ($) antes da vírgula para distingui-lo dos separadores. insira um máximo de 1024 caracteres. O valor não pode conter espaços ou os seguintes caracteres especiais "[]{}():? O sinal de dólar ($) pode ser usado apenas no modo de escape.
audit_types	Array of strings	Não	Este parâmetro só é válido quando a política de registo de auditoria está ativada. Se esse parâmetro for deixado em branco, todas as políticas de log de auditoria serão ativadas por padrão. Especifica o tipo de auditoria. O valor é auth, insert, delete, update, query ou command.

Exemplo de solicitação
- Habilitação ou atualização da política de log de auditoria
```
{
  "keep_days": 7,
  "audit_scope": "all",
  "audit_types": [
    "insert"
  ]
}
```
- Desabilitação da política para logs de auditoria do SQL:
```
{
  "keep_days": 0,
  "reserve_auditlogs": false
}
```

Respostas

Exemplo de resposta

{}

SDK

Clique em SDK do Document Database Service DDS para fazer download do SDK ou exibir o documento do SDK. Para saber como instalar e autenticar um SDK, leia a seção Uso.