DescribeCacheAnalysisJobs - - Centre de documentation Alibaba Cloud

Consulte la liste des tâches d'analyse de cache.

Description de l'opération

Avant d'appeler cette opération, prenez note des éléments suivants :

Si vous utilisez un SDK Alibaba Cloud ou un SDK Database Autonomy Service (DAS) pour appeler cette opération, nous vous recommandons d'utiliser la dernière version du SDK.
Si vous utilisez un SDK pour appeler les opérations d'API de DAS, vous devez définir l'identifiant de la région sur cn-shanghai.
Cette opération s'applique uniquement à ApsaraDB for Redis.

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

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant de l'instance.	r-bp18ff4a195d****
StartTime	string	Oui	Le début de la plage de temps à interroger. Définissez ce paramètre sur un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC.	1596177993000
EndTime	string	Oui	La fin de la plage de temps à interroger. Définissez ce paramètre sur un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC. Remarque L'heure de fin doit être postérieure à l'heure de début.	1596177993001
PageNo	string	Non	Le numéro de page. La valeur doit être un nombre entier supérieur à 0. Valeur par défaut : 1.	1
PageSize	string	Non	Le nombre d'entrées par page. Valeur par défaut : 10.	10

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
Message	string	Le message renvoyé. Remarque Si la requête a réussi, Successful est renvoyé. Si la requête a échoué, 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	La liste des tâches d'analyse 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. Remarque 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. Remarque 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	Le numéro de page. La valeur doit être un nombre entier supérieur à 0. Valeur par défaut : 1.	1
PageSize	integer	Le nombre d'entrées par page. Valeur par défaut : 10.	10
Extra	string	Le paramètre réservé.	None
Total	integer	Le nombre total d'entrées renvoyées.	4
Code	string	Le code d'état HTTP renvoyé.	200
Success	string	Indique si la requête a réussi. Valeurs valides : true : La requête a réussi. false : La requête a échoué.	true

Exemples

JSON format

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

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

Notes de version

Consultez Notes de version pour la liste complète.