DescribeCacheAnalysisJobs - - Centre de documentation Alibaba Cloud

Avant d'appeler cette opération, tenez compte des points suivants :

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

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeCacheAnalysisJobs	Opération à effectuer. Définissez la valeur sur DescribeCacheAnalysisJobs.
InstanceId	String	Oui	r-bp18ff4a195d****	ID de l'instance de base de données.
StartTime	String	Oui	1596177993000	Début de la plage de temps à interroger. Spécifiez l'heure au format d'horodatage UNIX. Unité : millisecondes.
EndTime	String	Oui	1596177993001	Fin de la plage de temps à interroger. Spécifiez l'heure au format d'horodatage UNIX. Unité : millisecondes. Remarque L'heure de fin doit être postérieure à l'heure de début.
PageNo	String	Non	1	Numéro de la page à renvoyer. La valeur doit être un entier supérieur à 0. Valeur par défaut : 1.
PageSize	String	Non	10	Nombre maximal d'entrées à renvoyer par page. Valeur par défaut : 10.

Paramètres de réponse

Paramètre	Type	Exemple	Description
Message	String	Successful	Message renvoyé pour la requête. Remarque Si la requête aboutit, Successful est renvoyé. En cas d'échec, un message d'erreur contenant des informations telles qu'un code d'erreur est renvoyé.
RequestId	String	B6D17591-B48B-4D31-9CD6-9B9796B2****	ID de la requête.
Data	Object		Détails de l'instance.
List	Array of CacheAnalysisJob		Détails des tâches d'analyse du cache.
CacheAnalysisJob
TaskState	String	BACKUP	État de la tâche d'analyse du cache. Valeurs possibles : BACKUP : Sauvegarde des données en cours. ANALYZING : Analyse des données en cours. FINISHED : Analyse des données terminée. FAILED : Une erreur s'est produite.
JobId	String	sf79-sd99-sa37-****	ID de la tâche d'analyse du cache.
Message	String	Successful	Message renvoyé pour la requête. Remarque Si la requête aboutit, Successful est renvoyé. En cas d'échec, un message d'erreur contenant des informations telles qu'un code d'erreur est renvoyé.
BigKeys	Array of KeyInfo		Détails concernant les grandes clés. Important Les sous-paramètres de ce paramètre et les valeurs correspondantes ne sont pas renvoyés. Pour interroger les détails des tâches d'analyse du cache, appelez l'opération DescribeCacheAnalysisJob.
KeyInfo
Type	String	hash	Type de données de l'instance.
Db	Integer	0	Nom de la base de données.
ExpirationTimeMillis	Long	1596256542547	Heure d'expiration de la clé. Unité : millisecondes. La valeur 0 indique que la clé n'expire pas.
Key	String	task_*****	Nom de la clé.
Encoding	String	hashtable	Type de données de la clé.
Bytes	Long	12345	Nombre d'octets occupés par la clé.
NodeId	String	r-****-db-0	ID du nœud de données sur l'instance.
Count	Long	127	Nombre d'éléments dans la clé.
InstanceId	String	r-bp18ff4a195d****	ID de l'instance de base de données.
NodeId	String	r-x****-db-0	ID du nœud de données sur l'instance.
PageNo	Long	1	Numéro de la page renvoyée. La valeur doit être un entier supérieur à 0. Valeur par défaut : 1.
PageSize	Long	10	Nombre maximal d'entrées renvoyées par page. Valeur par défaut : 10.
Extra	String	None	Paramètre réservé.
Total	Long	4	Nombre total de tâches d'analyse du cache.
Code	String	200	Code d'état HTTP renvoyé.
Success	String	true	Indique si la requête a abouti. Valeurs possibles : true : La requête a abouti. false : La requête a échoué.

Exemples

Exemples de requêtes

http(s)://das.cn-shanghai.aliyuncs.com/?Action=DescribeCacheAnalysisJobs
&InstanceId=r-bp18ff4a195d****
&StartTime=1596177993000
&EndTime=1596177993001
&PageNo=1
&PageSize=10
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeCacheAnalysisJobsResponse>
    <Message>Successful</Message>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Data>
        <List>
            <TaskState>BACKUP</TaskState>
            <JobId>sf79-sd99-sa37-****</JobId>
            <Message>Successful</Message>
            <BigKeys>
                <Type>hash</Type>
                <Db>0</Db>
                <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>
                <Key>task_*****</Key>
                <Encoding>hashtable</Encoding>
                <Bytes>12345</Bytes>
                <NodeId>r-****-db-0</NodeId>
                <Count>127</Count>
            </BigKeys>
            <InstanceId>r-bp18ff4a195d****</InstanceId>
            <NodeId>r-x****-db-0</NodeId>
        </List>
        <PageNo>1</PageNo>
        <PageSize>10</PageSize>
        <Extra>None</Extra>
        <Total>4</Total>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
</DescribeCacheAnalysisJobsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "Successful",
  "RequestId" : "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data" : {
    "List" : [ {
      "TaskState" : "BACKUP",
      "JobId" : "sf79-sd99-sa37-****",
      "Message" : "Successful",
      "BigKeys" : [ {
        "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 d'état HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParams	The request parameters are invalid.	Le message d'erreur renvoyé indique que les paramètres de requête spécifiés ne sont pas valides.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.