CreateCacheAnalysisJob - Database Autonomy Service - Centro de documentación de Alibaba Cloud

Crea una tarea de análisis de caché mediante la operación CreateCacheAnalysisJob.

Descripción de la operación

Antes de comenzar:

Utilice la versión más reciente del SDK de Alibaba Cloud o de DAS.
Al llamar a DAS mediante el SDK, configure la región en cn-shanghai.
Solo se admiten para análisis las estructuras de datos de Redis y las siguientes estructuras de datos desarrolladas por Tair: TairString, TairHash, TairGIS, TairBloom, TairDoc, TairCpc y TairZset. No se admiten otras estructuras de datos desarrolladas por Tair.
Si se han modificado las especificaciones de la instancia de destino, no se pueden analizar los archivos de respaldo generados antes del cambio.
No se admiten instancias basadas en Tair ESSD.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

hdm:CreateCacheAnalysisJob

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia de Redis.	r-bp18ff4a195d****
NodeId	string	No	El ID del nodo de datos en la instancia. Especifique este parámetro para consultar la información de monitoreo de un nodo específico. Nota Si especifica el parámetro BackupSetId, este parámetro se ignora. Puede llamar a la operación DescribeLogicInstanceTopology para consultar los ID de los nodos.	r-x****-db-0
BackupSetId	string	No	El ID del archivo de respaldo. Puede llamar a la operación DescribeBackups para obtener el ID del archivo de respaldo. Para especificar varios ID de archivos de respaldo, sepárelos con comas (,), por ejemplo, `12345,67890`. Si no especifica este parámetro, el sistema realiza automáticamente un respaldo y ejecuta el análisis de caché en el archivo de respaldo.	12345
Separators	string	No	Los delimitadores utilizados para identificar prefijos de claves. No necesita especificar este parámetro si se utilizan los delimitadores predeterminados `:;,_-+@=\|#`.	&

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
Message	string	El mensaje devuelto. Nota Si la solicitud es exitosa, se devuelve Successful. Si la solicitud falla, se devuelve un mensaje de error, como un código de error.	Successful
RequestId	string	El ID de la solicitud.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	Los detalles.
TaskState	string	El estado de la tarea de análisis de caché. Valores válidos: BACKUP: El sistema está realizando un respaldo. ANALYZING: El sistema está analizando el archivo de respaldo. FINISHED: El análisis ha finalizado. FAILED: Ocurrió un error.	BACKUP
JobId	string	El ID de la tarea de análisis de caché de consulta. Nota Puede utilizar este parámetro para consultar la tarea de análisis de caché de consulta. Dado que crear una tarea de análisis de caché toma cierto tiempo, el resultado del análisis no se devuelve inmediatamente al llamar a esta operación. Utilice este parámetro junto con la operación DescribeCacheAnalysisJob para consultar el resultado del análisis.	sf79-sd99-sa37-****
Message	string	El mensaje devuelto. Nota Si la solicitud es exitosa, se devuelve Successful. Si la solicitud falla, se devuelve un mensaje de error, como un código de error.	Successful
BigKeys	object
KeyInfo	array<object>	Los detalles de las claves grandes, ordenados en orden descendente según el número de bytes ocupados por la clave.
	object
Type	string	El tipo de estructura de datos de Redis.	hash
Db	integer	El nombre de la base de datos.	0
ExpirationTimeMillis	integer	La hora de caducidad de la clave. Unidad: milisegundos (ms). Un valor de 0 indica que la clave no caduca.	1596256542547
Key	string	El nombre de la clave.	task_x****
Encoding	string	El tipo de datos interno de la clave.	hashtable
Bytes	integer	El número de bytes ocupados por la clave.	12345
NodeId	string	El ID del nodo de datos en la instancia.	r-x****-db-0
Count	integer	El número de elementos en la clave.	127
InstanceId	string	El ID de la instancia.	r-bp18ff4a195d****
NodeId	string	El ID del nodo de datos en la instancia.	r-x****-db-0
Code	string	El código de estado devuelto.	200
Success	string	Indica si la solicitud fue exitosa. Valores válidos: true: La solicitud fue exitosa. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

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 error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permissions to perform this operation.

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.