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

Cria uma tarefa de análise de cache.

Descrição da operação

Antes de chamar esta operação, observe os seguintes itens:

Se você usar um SDK da Alibaba Cloud ou o SDK do Database Autonomy Service (DAS) para chamar esta operação, recomendamos que utilize a versão mais recente do SDK.
Se você usar um SDK para chamar as operações de API do DAS, deve definir o ID da região como cn-shanghai.
Analisa as estruturas de dados do ApsaraDB for Redis e as seguintes estruturas de dados autodesenvolvidas do Tair: TairString, TairHash, TairGIS, TairBloom, TairDoc, TairCpc e TairZset. Outras estruturas de dados autodesenvolvidas do Tair não são suportadas.
Se as especificações da instância de banco de dados que você deseja analisar forem alteradas, o arquivo de backup gerado antes da alteração de especificação não poderá ser analisado.
Instâncias Tair baseadas em ESSD/SSD não são suportadas.

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

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância do ApsaraDB for Redis.	r-bp18ff4a195d****
NodeId	string	Não	O ID do nó de dados na instância. Você pode especificar este parâmetro para consultar as informações de monitoramento sobre o nó especificado. Nota Se você especificar o parâmetro BackupSetId, o sistema ignorará o parâmetro NodeId. Você pode chamar a operação DescribeLogicInstanceTopology para consultar o ID do nó.	r-x****-db-0
BackupSetId	string	Não	O ID do arquivo de backup. Você pode chamar a operação DescribeBackups para consultar o ID. Se você precisar especificar vários IDs de arquivo de backup, separe-os com vírgulas (,). Por exemplo, você pode definir este parâmetro como `12345,67890`. Se você não especificar este parâmetro, o sistema realizará automaticamente o backup da tarefa e executará a análise de cache no arquivo de backup.	12345
Separators	string	Não	Os delimitadores usados para identificar os prefixos das chaves. Você não precisa especificar este parâmetro se um ou mais dos seguintes delimitadores padrão forem usados: `: ; , _ - + @ = \| #`	&

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	The response parameters.
Message	string	A mensagem retornada. Nota Se a solicitação foi bem-sucedida, Successful é retornado. Se a solicitação falhou, uma mensagem de erro, como um código de erro, é retornada.	Successful
RequestId	string	O ID da solicitação.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	As informações detalhadas.
TaskState	string	O estado da tarefa de análise de cache. Valores válidos: BACKUP: Os dados estão sendo copiados em backup. ANALYZING: Os dados estão sendo analisados. FINISHED: Os dados foram analisados. FAILED: Ocorreu um erro.	BACKUP
JobId	string	O ID da tarefa de análise de cache. Nota Este parâmetro pode ser usado para consultar uma tarefa de análise de cache específica. Ao chamar a operação CreateCacheAnalysisJob, leva algum tempo para criar uma tarefa de análise de cache. Como resultado, os resultados da análise não podem ser retornados imediatamente. Você pode chamar a operação DescribeCacheAnalysisJob para consultar os resultados da análise da tarefa de análise de cache especificada.	sf79-sd99-sa37-****
Message	string	A mensagem retornada. Nota Se a solicitação foi bem-sucedida, Successful é retornado. Se a solicitação falhou, uma mensagem de erro, como um código de erro, é retornada.	Successful
BigKeys	object
KeyInfo	array<object>	The number of elements in the key.
	object
Type	string	The data type of the ApsaraDB for Redis instance.	hash
Db	integer	The name of the database.	0
ExpirationTimeMillis	integer	The expiration period of the key. Unit: milliseconds. A value of 0 indicates that the key does not expire.	1596256542547
Key	string	The name of the key.	task_x****
Encoding	string	The data type of the key.	hashtable
Bytes	integer	The number of bytes that are occupied by the key.	12345
NodeId	string	The ID of the data node on the instance.	r-x****-db-0
Count	integer	The number of elements in the key.	127
InstanceId	string	O ID da instância.	r-bp18ff4a195d****
NodeId	string	O ID do nó de dados na instância.	r-x****-db-0
Code	string	O código de status HTTP retornado.	200
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

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "TaskState": "BACKUP",
    "JobId": "sf79-sd99-sa37-****",
    "Message": "Successful",
    "BigKeys": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "InstanceId": "r-bp18ff4a195d****",
    "NodeId": "r-x****-db-0"
  },
  "Code": "200",
  "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.
403	NoPermission	You are not authorized to do this action.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.