DescribeHybridMonitorTaskList - - Centre de documentation Alibaba Cloud

Cette rubrique explique comment interroger toutes les tâches d'importation de métriques associées au compte Alibaba Cloud actuel. Le résultat renvoyé indique que le compte ne possède qu'une seule tâche d'importation de métriques, nommée aliyun_task.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. L'outil génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeHybridMonitorTaskList	Opération à exécuter. Définissez la valeur sur DescribeHybridMonitorTaskList.
Keyword	String	Non	task	Mot-clé utilisé pour rechercher des tâches d'importation de métriques.
TaskId	String	Non	36****	ID de la tâche d'importation de métriques.
GroupId	String	Non	3607****	ID du groupe d'applications. Pour obtenir l'ID d'un groupe d'applications, consultez la page DescribeMonitorGroups.
Namespace	String	Non	aliyun	Nom du namespace. Pour obtenir le nom d'un namespace, consultez la page DescribeHybridMonitorNamespaceList.
PageSize	Integer	Non	10	Nombre d'entrées par page. Valeur minimale : 1. Valeur par défaut : 10.
PageNumber	Integer	Non	1	Numéro de page. La numérotation commence à 1. Valeur par défaut : 1.
IncludeAliyunTask	Boolean	Non	true	Indique si le résultat inclut les tâches d'importation de métriques pour les services Alibaba Cloud. Valeurs possibles : true (par défaut) : inclut les tâches d'importation de métriques pour les services Alibaba Cloud. false : exclut les tâches d'importation de métriques pour les services Alibaba Cloud.
TaskType	String	Non	aliyun_fc	Type de la tâche d'importation de métriques. Valeurs possibles : aliyun_fc : tâches d'importation de métriques pour les services Alibaba Cloud aliyun_sls : métriques issues des journaux importés depuis Log Service
TargetUserId	Long	Non	120886317861****	ID du compte membre. Remarque Ce paramètre est requis uniquement lors de la suppression de tâches d'importation de métriques appartenant à un membre d'un annuaire de ressources. Dans ce cas, définissez le paramètre `TaskType` sur `aliyun_fc`.

Pour plus d'informations sur les paramètres de requête courants, consultez la page Paramètres courants.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	11145B76-566A-5D80-A8A3-FAD98D310079	ID de la requête.
Success	String	true	Indique si la requête a abouti. Valeurs possibles : true false
Code	String	200	Code d'état. Remarque Le code 200 indique que la requête a abouti.
Message	String	success	Message renvoyé. En cas de succès, la valeur `successful` est renvoyée. En cas d'échec, un message d'erreur est renvoyé.
PageSize	Integer	10	Nombre d'entrées par page.
PageNumber	Integer	1	Numéro de page.
Total	Integer	1	Nombre total d'entrées renvoyées.
TaskList	Array of TaskList		Tâches d'importation de métriques.
YARMConfig	String	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total	Fichier de configuration du service Alibaba Cloud à surveiller via Hybrid Cloud Monitoring. namespace : namespace du service Alibaba Cloud. metric_list : métriques du service Alibaba Cloud.
CreateTime	String	1639382496000	Horodatage de création de la tâche d'importation de métriques. Unité : millisecondes.
TaskName	String	aliyun_task	Nom de la tâche d'importation de métriques.
Namespace	String	aliyun	Namespace auquel l'hôte appartient.
UploadRegion	String	cn-hangzhou	Région où réside l'hôte.
NetworkType	String	vpc	Type de réseau de l'hôte. Valeurs possibles : `vpc` : VPC `Internet` : Internet
CollectTimout	Integer	15	Délai d'expiration de la collecte des données de surveillance de l'hôte par l'agent CloudMonitor. Valeurs possibles : 0 15 30 60 Unité : secondes.
CollectTargetEndpoint	String	http://localhost	URL de la destination depuis laquelle l'agent CloudMonitor collecte les données de surveillance de l'hôte.
TaskType	String	aliyun_sls	Type de la tâche d'importation de métriques. Valeurs possibles : aliyun_fc : tâches d'importation de métriques pour les services Alibaba Cloud aliyun_sls : métriques issues des journaux importés depuis Log Service
MatchExpressRelation	String	or	Relation entre les conditions de filtrage des tâches d'importation de métriques. Valeurs possibles : or and
Description	String	aliyun	Description de la tâche d'importation de métriques.
GroupId	String	3607****	ID du groupe d'applications.
CollectInterval	Integer	60	Intervalle de collecte des données de surveillance de l'hôte par l'agent CloudMonitor. Valeurs possibles : 15 30 60 Unité : secondes.
TargetUserId	String	120886317861****	ID du compte membre. Remarque Ce paramètre est renvoyé uniquement si vous appelez cette opération avec un compte de gestion.
CollectTargetPath	String	/metrics	Chemin relatif depuis lequel l'agent CloudMonitor collecte les données de surveillance.
CollectTargetType	String	nginx	Type des données de surveillance. Valeurs possibles : Spring, Tomcat, Nginx, Tengine, JVM, Redis et MySQL.
TaskId	String	36****	ID de la tâche d'importation de métriques.
AttachLabels	Array of AttachLabels		Tags de la tâche d'importation de métriques.
Name	String	key1	Clé du tag.
Value	String	value1	Valeur du tag.
MatchExpress	Array of MatchExpress		Conditions de mise en correspondance des instances du groupe d'applications.
Value	String	ECS_instance1	Mot-clé correspondant au nom de l'instance.
Name	String	name	Nom de l'instance surveillée.
Function	String	all	Méthode de mise en correspondance du nom de l'instance. Valeurs possibles : startWith : commence par un préfixe endWith : se termine par un suffixe all : correspond à tout equals : égal à contains : contient notContains : ne contient pas
Instances	Array of String	i-hp368focau7dp0hw****	ID de l'instance.
ExtraInfo	String	test	Informations supplémentaires sur l'instance.
LogFilePath	String	C:\UserData\log\*.Log	Chemin de stockage des données de journal locales sur l'hôte où CloudMonitor est déployé. Windows : le chemin doit commencer par une lettre de lecteur. Exemple : `C:\UserData\log\.Log`. Les caractères génériques ne sont pas autorisés dans le chemin. Linux : le chemin doit commencer par une barre oblique (/). Exemple : `/home/appdata/log//.log`. Ici, `/**/` correspond à tous les fichiers du répertoire appdata.
LogSplit	String	{"type": "regex","regex": "\\d+\\.\\d+\\.\\d+\\.\\d+\\s+(\\d+)\\s+\\S+\\s+\\[\\d+/\\S+/\\d+:\\d+:\\d+:\\d+\\s+\\+\\d+\\]\\s+(\\S+)\\s+\\S+\\s+/\\S+/\\S+/\\S+\\s+(\\d+)","columns": [{"name": "field1"},{"name": "filed2","translate": {"default": "-","mappings": [{"from": "(\\w+)","to": "$1x","type": "regex"}]}},{"name": "filed3","translate": {"default": "-","mappings": [{"from": "NumberRange(100.300)","to": "true","type": "function"}]}}]}	Résultat du fractionnement des données de journal locales selon le mode de correspondance spécifié. Remarque Les modes de correspondance disponibles sont : regex complet, délimiteur et JSON.
LogProcess	String	[{"metric": "metric1","filters": [{"column": "filed2","type": "include","values": ["222222"]}],"groupBys": [{"column": "filed3","name": "filed3"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]},{"metric": "metric2","filters": [{"column": "field1","type": "include","values": ["11111"]}],"groupBys": [{"column": "filed2","name": "filed2"}],"calculates": [{"column": "field1","name": "avg","type": "avg"}]}]	Méthode d'agrégation des données de journal locales.
LogSample	String	{"logContent":"100.116.134.26 1119 - [13/Aug/2019:16:55:46 +0800] POST metrichub-cn-hongkong.aliyun.com /agent/metrics/putLines 200 0 \"-\" \"127.0.0.1:7001\" \"Go-http-client/1.1\" \"-\" \"-\" \"0a98a21a15656865460656276e\"","addData":{"field1":["1119","1119"],"filed2":["POSTx","POST"],"filed3":["true","200"]}}	Exemple de journal local.
SLSProcess	String	{"express": [],"filter": {"filters": [{"key": "task_type","operator": "=","value": "1"}]},"groupby": [{"alias": "isp","key": "isp","sqlKey": "t.`isp`","valueKey": "isp"}],"interval": 60,"labels": [{"name": "__cms_app__","type": 0,"value": "sitemonitor"}],"statistics": [{"alias": "http_dns_time_avg","function": "avg","key": "http_dns_time"}]}	Configuration des journaux importés depuis Log Service.
SLSProcessConfig	Object		Configuration des journaux importés depuis Log Service. Remarque Ce paramètre est renvoyé uniquement si le paramètre `TaskType` est défini sur `aliyun_sls`.
Filter	Object		Conditions de filtrage des journaux importés depuis Log Service.
Relation	String	and	Relation entre plusieurs conditions de filtre. Valeurs possibles : and (par défaut) : les journaux sont traités uniquement si toutes les conditions sont remplies. or : les journaux sont traités si au moins une condition est remplie.
Filters	Array of Filters		Conditions de filtrage des journaux importés depuis Log Service.
SLSKeyName	String	host	Nom de la clé utilisée pour filtrer les journaux importés depuis Log Service.
Operator	String	=	Opérateur de filtrage des journaux importés depuis Log Service. Valeurs possibles : `contain` : contient `notContain` : ne contient pas `>` : supérieur à `<` : inférieur à `=` : égal à `! =` : différent de `>=` : supérieur ou égal à `<=` : inférieur ou égal à
Value	String	200	Valeur de la clé utilisée pour filtrer les journaux importés depuis Log Service.
Statistics	Array of Statistics		Méthode d'agrégation des journaux importés depuis Log Service.
SLSKeyName	String	name	Nom de la clé utilisée pour agréger les journaux importés depuis Log Service.
Function	String	count	Fonction d'agrégation des données de journal sur une période statistique. Valeurs possibles : count : nombre de valeurs du champ spécifié. sum : somme des valeurs du champ spécifié. avg : moyenne des valeurs du champ spécifié. max : valeur maximale du champ spécifié. min : valeur minimale du champ spécifié. value : échantillons collectés durant la période statistique. countps : somme des valeurs du champ spécifié divisée par le nombre total de secondes de la période statistique. sumps : nombre de valeurs du champ spécifié divisé par le nombre total de secondes de la période statistique. distinct : nombre de valeurs uniques du champ spécifié durant la période statistique. distribution : nombre de journaux répondant à une condition donnée durant la période statistique. percentile : valeur située au centile spécifié (par exemple P50) après tri croissant des valeurs du champ spécifié durant la période statistique.
Alias	String	level_count	Alias du résultat d'agrégation.
Parameter1	String	200	Valeur de la fonction d'agrégation des journaux importés depuis Log Service. Si le paramètre `Function` est défini sur `distribution`, ce paramètre spécifie la borne inférieure de l'intervalle statistique. Par exemple, pour calculer le nombre de requêtes HTTP avec un code d'état 2XX, définissez ce paramètre sur 200. Si le paramètre `Function` est défini sur `percentile`, ce paramètre spécifie le centile attendu. Par exemple, 0,5 correspond à P50.
Parameter2	String	299	Valeur de la fonction d'agrégation des journaux importés depuis Log Service. Remarque Ce paramètre est renvoyé uniquement si le paramètre `Function` est défini sur `distribution`. Il indique la borne supérieure de l'intervalle statistique. Par exemple, 299 permet de calculer le nombre de requêtes HTTP avec un code d'état 2XX.
GroupBy	Array of GroupBy		Dimension d'agrégation des données (équivalent à la clause GROUP BY en SQL).
SLSKeyName	String	code	Nom de la clé utilisée pour agréger les journaux importés depuis Log Service.
Alias	String	ApiResult	Alias du résultat d'agrégation.
Express	Array of Express		Champs étendus indiquant les résultats des opérations de base appliquées aux résultats d'agrégation.
Express	String	success_count	Champ étendu indiquant le résultat des opérations de base appliquées aux résultats d'agrégation.
Alias	String	SuccRate	Alias du champ étendu indiquant le résultat des opérations de base appliquées aux résultats d'agrégation.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=DescribeHybridMonitorTaskList
&<Common request parameters>

Exemples de réponses réussies

Format XML

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

<DescribeHybridMonitorTaskListResponse>
	<RequestId>11145B76-566A-5D80-A8A3-FAD98D310079</RequestId>
	<PageSize>10</PageSize>
	<PageNumber>1</PageNumber>
	<Total>1</Total>
	<TaskList>
		<CollectTimout>15</CollectTimout>
		<CollectInterval>0</CollectInterval>
		<Description></Description>
		<TaskId>36****</TaskId>
		<CreateTime>1639382496000</CreateTime>
		<YARMConfig></YARMConfig>
		<CollectTargetPath></CollectTargetPath>
		<Namespace>aliyun</Namespace>
		<GroupId>0</GroupId>
		<MatchExpressRelation></MatchExpressRelation>
		<SLSProcess>{\"express\":[],\"filter\":{\"filters\":[]},\"groupby\":[],\"interval\":60,\"labels\":[],\"statistics\":[{\"alias\":\"referer_count\",\"function\":\"count\",\"key\":\"referer\"}]}</SLSProcess>
		<CollectTargetEndpoint></CollectTargetEndpoint>
		<TaskName>aliyun_task</TaskName>
		<UploadRegion>unknown</UploadRegion>
		<NetworkType>vpc</NetworkType>
		<TaskType>aliyun_sls</TaskType>
		<CollectTargetType></CollectTargetType>
		<TargetUserId></TargetUserId>
	</TaskList>
	<Code>200</Code>
	<Success>true</Success>
</DescribeHybridMonitorTaskListResponse>

Format JSON

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

{
  "RequestId" : "11145B76-566A-5D80-A8A3-FAD98D310079",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Total" : 1,
  "TaskList" : [ {
    "CollectTimout" : 15,
    "CollectInterval" : 0,
    "Description" : "",
    "TaskId" : "36****",
    "CreateTime" : 1639382496000,
    "AttachLabels" : [ ],
    "YARMConfig" : "",
    "CollectTargetPath" : "",
    "Namespace" : "aliyun",
    "GroupId" : 0,
    "MatchExpressRelation" : "",
    "Instances" : [ ],
    "SLSProcess" : "{\"express\":[],\"filter\":{\"filters\":[]},\"groupby\":[],\"interval\":60,\"labels\":[],\"statistics\":[{\"alias\":\"referer_count\",\"function\":\"count\",\"key\":\"referer\"}]}",
    "CollectTargetEndpoint" : "",
    "TaskName" : "aliyun_task",
    "UploadRegion" : "unknown",
    "NetworkType" : "vpc",
    "TaskType" : "aliyun_sls",
    "CollectTargetType" : "",
    "TargetUserId" : ""
  } ],
  "Code" : 200,
  "Success" : true
}

Codes d'erreur

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