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

Consulta uma lista de tarefas 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 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.

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

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****
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Defina este parâmetro como um timestamp UNIX representando o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC.	1596177993000
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. Defina este parâmetro como um timestamp UNIX representando o número de milissegundos decorridos desde 1º de janeiro de 1970, 00:00:00 UTC. Nota O horário de término deve ser posterior ao horário de início.	1596177993001
PageNo	string	Não	O número da página. O valor deve ser um inteiro maior que 0. Valor padrão: 1.	1
PageSize	string	Não	O número de entradas por página. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
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	A lista de tarefas de análise de cache.
List	object
CacheAnalysisJob	array<object>	The ID of the data node on the instance.
	array<object>
TaskState	string	The state of the cache analysis task. Valid values: BACKUP: The data is being backed up. ANALYZING: The data is being analyzed. FINISHED: The data is analyzed. FAILED: An error occurred.	BACKUP
JobId	string	The ID of the cache analysis task.	sf79-sd99-sa37-****
Message	string	The returned message. Nota If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.	Successful
BigKeys	object
KeyInfo	array<object>	The details about the large keys. Nota The sub-parameters of this parameter and the content of the sub-parameters are not returned. To query the detailed information about the cache analysis tasks, call the DescribeCacheAnalysisJob operation.
	object
Type	string	The data type of the 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_*****
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-****-db-0
Count	integer	The number of elements in the key.	127
InstanceId	string	The instance ID.	r-bp18ff4a195d****
NodeId	string	The ID of the data node on the instance.	r-x****-db-0
PageNo	integer	O número da página. O valor deve ser um inteiro maior que 0. Valor padrão: 1.	1
PageSize	integer	O número de entradas por página. Valor padrão: 10.	10
Extra	string	O parâmetro reservado.	None
Total	integer	O número total de entradas retornadas.	4
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": {
    "List": {
      "CacheAnalysisJob": [
        {
          "TaskState": "BACKUP",
          "JobId": "sf79-sd99-sa37-****",
          "Message": "Successful",
          "BigKeys": {
            "KeyInfo": [
              {
                "Type": "hash",
                "Db": 0,
                "ExpirationTimeMillis": 1596256542547,
                "Key": "task_*****",
                "Encoding": "hashtable",
                "Bytes": 12345,
                "NodeId": "r-****-db-0",
                "Count": 127
              }
            ]
          },
          "InstanceId": "r-bp18ff4a195d****",
          "NodeId": "r-x****-db-0"
        }
      ]
    },
    "PageNo": 1,
    "PageSize": 10,
    "Extra": "None",
    "Total": 4
  },
  "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.