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

Retorna detalhes de 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 um SDK do Database Autonomy Service (DAS) para chamar esta operação, recomendamos que use 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.
Esta operação é aplicável apenas ao ApsaraDB for Redis.

Nota

Retorna as 500 principais chaves em uma tarefa de análise de cache.

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

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	r-bp18ff4a195d****
JobId	string	Sim	O ID da tarefa de análise de cache. Você pode obter o ID da tarefa a partir dos parâmetros de resposta da operação CreateCacheAnalysisJob.	sf79-sd99-sa37-****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
Message	string	A mensagem retornada para a solicitação. Nota Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, uma mensagem de erro contendo informações como um código de erro será retornada.	Successful
RequestId	string	O ID da solicitação.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	Os detalhes da tarefa de análise de cache.
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.	sf79-sd99-sa37-****
Message	string	A mensagem retornada para a solicitação. Nota Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, uma mensagem de erro contendo informações como um código de erro será retornada.	Successful
BigKeys	object
KeyInfo	array<object>	The details of the large keys. The returned large keys are sorted in descending order based on the number of bytes occupied by the keys.
	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	integer	The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.	1596256542547
Key	string	The key name.	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
KeyPrefixes	object
Prefix	array<object>	The prefixes of the keys.
	object
KeyNum	integer	The number of keys that contain the prefix.	123
Type	string	The data type of the instance.	hash
Bytes	integer	The number of bytes that are occupied by the key.	12345
Prefix	string	The prefix of the key.	task_
Count	integer	The number of elements in the key.	127
BigKeysOfNum	object
KeyInfo	array<object>	The details of the large keys. The returned large keys are sorted in descending order based on the number of keys.
	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	integer	The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.	1596256542547
Key	string	The key name.	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
UnexBigKeysOfBytes	object
KeyInfo	array<object>	The details of permanent keys. The returned keys are sorted in descending order based on the number of bytes occupied by the keys.
	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	integer	The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.	1596256542547
Key	string	The key name.	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
UnexBigKeysOfNum	object
KeyInfo	array<object>	The details of permanent keys. The returned keys are sorted in descending order based on the number of keys.
	object
Type	string	The data type of the instance.	hash
Db	integer	The database name.	0
ExpirationTimeMillis	integer	The time when the key expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A value of 0 indicates that the key never expires.	1596256542547
Key	string	The key name.	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
ExpiryKeysLevelCount	object
ExpiryLevel	array<object>	The statistics of the keys that have expired.
	object
AnalysisTs	integer	The time when the cache analysis task was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1717469347000
Level	integer	The expiration level. Valid values: 0: The key never expires. 1: The key has expired. 2: The key has expired for 0 to 1 hour. 3: The key has expired for 1 to 3 hours. 4: The key has expired for 3 to 12 hours. 5: The key has expired for 12 to 24 hours. 6: The key has expired for one to two days. 7: The key has expired for three to seven days. 8: The key has expired for more than seven days.	0
TotalBytes	integer	The number of bytes occupied by the keys that have expired.	8064
TotalKeys	integer	The total number of the keys that have expired.	62
Code	string	O código de status HTTP retornado.	200
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true false	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
        }
      ]
    },
    "KeyPrefixes": {
      "Prefix": [
        {
          "KeyNum": 123,
          "Type": "hash",
          "Bytes": 12345,
          "Prefix": "task_",
          "Count": 127
        }
      ]
    },
    "BigKeysOfNum": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "UnexBigKeysOfBytes": {
      "KeyInfo": [
        {
          "Type": "hash",
          "Db": 0,
          "ExpirationTimeMillis": 1596256542547,
          "Key": "task_x****",
          "Encoding": "hashtable",
          "Bytes": 12345,
          "NodeId": "r-x****-db-0",
          "Count": 127
        }
      ]
    },
    "UnexBigKeysOfNum": {
      "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",
    "ExpiryKeysLevelCount": {
      "ExpiryLevel": [
        {
          "AnalysisTs": 1717469347000,
          "Level": 0,
          "TotalBytes": 8064,
          "TotalKeys": 62
        }
      ]
    }
  },
  "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.