CreateCacheAnalysisJob - - Centre de documentation Alibaba Cloud

Crée une tâche d'analyse de cache en appelant l'opération CreateCacheAnalysisJob.

Description de l'opération

Avant de commencer :

Utilisez la dernière version du SDK Alibaba Cloud ou DAS.
Lors de l'appel à DAS via le SDK, définissez la région sur cn-shanghai.
Seules les structures de données Redis et les structures de données développées par Tair suivantes sont prises en charge pour l'analyse : TairString, TairHash, TairGIS, TairBloom, TairDoc, TairCpc et TairZset. Les autres structures de données développées par Tair ne sont pas prises en charge.
Si les spécifications de l'instance cible ont été modifiées, les fichiers de sauvegarde générés avant la modification ne peuvent pas être analysés.
Les instances basées sur Tair ESSD ne sont pas prises en charge.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

hdm:CreateCacheAnalysisJob

create

*Toutes les ressources.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant de l'instance Redis.	r-bp18ff4a195d****
NodeId	string	Non	L'identifiant du nœud de données dans l'instance. Spécifiez ce paramètre pour interroger les informations de surveillance d'un nœud spécifique. Remarque Si vous spécifiez le paramètre BackupSetId, ce paramètre est ignoré. Vous pouvez appeler l'opération DescribeLogicInstanceTopology pour interroger les identifiants des nœuds.	r-x****-db-0
BackupSetId	string	Non	L'identifiant du fichier de sauvegarde. Vous pouvez appeler l'opération DescribeBackups pour obtenir l'identifiant du fichier de sauvegarde. Pour spécifier plusieurs identifiants de fichiers de sauvegarde, séparez-les par des virgules (,), par exemple `12345,67890`. Si vous ne spécifiez pas ce paramètre, le système effectue automatiquement une sauvegarde et exécute l'analyse du cache sur le fichier de sauvegarde.	12345
Separators	string	Non	Les délimiteurs utilisés pour identifier les préfixes de clé. Vous n'avez pas besoin de spécifier ce paramètre si les délimiteurs par défaut `:;,_-+@=\|#` sont utilisés.	&

Éléments de réponse

Élément	Type	Description	Exemple
	object
Message	string	Le message renvoyé. Remarque Si la requête aboutit, Successful est renvoyé. Si la requête échoue, un message d'erreur tel qu'un code d'erreur est renvoyé.	Successful
RequestId	string	L'identifiant de la requête.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	Les détails.
TaskState	string	L'état de la tâche d'analyse de cache. Valeurs valides : BACKUP : le système effectue une sauvegarde. ANALYZING : le système analyse le fichier de sauvegarde. FINISHED : l'analyse est terminée. FAILED : une erreur s'est produite.	BACKUP
JobId	string	L'identifiant de la tâche d'analyse de cache. Remarque Vous pouvez utiliser ce paramètre pour interroger la tâche d'analyse de cache. Étant donné que la création d'une tâche d'analyse de cache prend un certain temps, le résultat de l'analyse n'est pas renvoyé immédiatement lors de l'appel de cette opération. Utilisez ce paramètre conjointement avec l'opération DescribeCacheAnalysisJob pour interroger le résultat de l'analyse.	sf79-sd99-sa37-****
Message	string	Le message renvoyé. Remarque Si la requête aboutit, Successful est renvoyé. Si la requête échoue, un message d'erreur tel qu'un code d'erreur est renvoyé.	Successful
BigKeys	object
KeyInfo	array<object>	Les détails des clés volumineuses, triés par ordre décroissant en fonction du nombre d'octets occupés par la clé.
	object
Type	string	Le type de structure de données Redis.	hash
Db	integer	Le nom de la base de données.	0
ExpirationTimeMillis	integer	L'heure d'expiration de la clé. Unité : millisecondes (ms). Une valeur de 0 indique que la clé n'expire pas.	1596256542547
Key	string	Le nom de la clé.	task_x****
Encoding	string	Le type de données interne de la clé.	hashtable
Bytes	integer	Le nombre d'octets occupés par la clé.	12345
NodeId	string	L'identifiant du nœud de données dans l'instance.	r-x****-db-0
Count	integer	Le nombre d'éléments dans la clé.	127
InstanceId	string	L'identifiant de l'instance.	r-bp18ff4a195d****
NodeId	string	L'identifiant du nœud de données dans l'instance.	r-x****-db-0
Code	string	Le code d'état renvoyé.	200
Success	string	Indique si la requête a abouti. Valeurs valides : true : la requête a abouti. false : la requête a échoué.	true

Exemples

JSON format

{
  "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"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParams	The request parameters are invalid.	Les paramètres de la requête sont invalides.
403	NoPermission	You are not authorized to do this action.	Vous ne disposez pas des autorisations nécessaires pour effectuer cette opération.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.