DescribeHybridMonitorTaskList - - Centre de documentation Alibaba Cloud

Consulte les tâches d'importation de métriques.

Description de l'opération

Cette rubrique fournit un exemple de requête de toutes les tâches d'importation de métriques appartenant au compte Alibaba Cloud actuel. Le résultat renvoyé indique que le compte actuel ne possède qu'une seule tâche d'importation de métriques. La tâche d'importation de métriques est nommée aliyun_task.

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.

cms:DescribeHybridMonitorTaskList

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Keyword	string	Non	Le mot-clé utilisé pour la recherche.	task
TaskId	string	Non	L'identifiant de la tâche d'importation de métriques.	36****
GroupId	string	Non	L'identifiant du groupe d'applications. Pour plus d'informations sur la manière d'obtenir l'identifiant d'un groupe d'applications, consultez DescribeMonitorGroups.	3607****
Namespace	string	Non	Le nom de l'espace de noms. Pour plus d'informations sur la manière d'obtenir le nom d'un espace de noms, consultez DescribeHybridMonitorNamespaceList.	aliyun
PageSize	integer	Non	Le nombre d'entrées par page.	10
PageNumber	integer	Non	Le numéro de page.	1
IncludeAliyunTask	boolean	Non	Indique si le résultat retourné inclut les tâches d'importation de métriques pour les services Alibaba Cloud. Valeurs valides : true (par défaut) : Le résultat retourné inclut les tâches d'importation de métriques pour les services Alibaba Cloud. false : Le résultat retourné exclut les tâches d'importation de métriques pour les services Alibaba Cloud.	true
TaskType	string	Non	Le type de tâche d'importation de métriques. Valeurs valides : aliyun_fc : tâches d'importation de métriques pour les services Alibaba Cloud aliyun_sls : métriques pour les journaux importés depuis Log Service Valeurs valides : aliyun_sls : aliyun_sls.	aliyun_fc
TargetUserId	integer	Non	L'identifiant du compte membre. Remarque Ce paramètre est requis uniquement si vous utilisez un compte de gestion pour appeler cette opération afin de supprimer les tâches d'importation de métriques qui appartiennent à un membre dans un répertoire de ressources. Dans ce cas, le paramètre TaskType est défini sur aliyun_fc.	120886317861****

Pour plus d'informations sur les paramètres de requête communs, voir Paramètres communs.

Éléments de réponse

Élément	Type	Description	Exemple
	object	Aucun.
RequestId	string	L'identifiant de la requête.	11145B76-566A-5D80-A8A3-FAD98D310079
Success	string	Indique si la requête a réussi. Valeurs valides :	true
Code	string	Le code d'état. Remarque Le code d'état 200 indique que la requête a réussi.	200
Message	string	Le message retourné. Si la requête a réussi, la valeur `successful` est retournée. Si la requête a échoué, un message d'erreur est retourné.	success
PageSize	integer	Le nombre d'entrées par page.	10
PageNumber	integer	Le numéro de page.	1
Total	integer	Le nombre total d'entrées renvoyées.	1
TaskList	array<object>	Les tâches d'importation de métriques.
	array<object>	Aucun.
YARMConfig	string	Le fichier de configuration du service Alibaba Cloud que vous souhaitez surveiller à l'aide de Hybrid Cloud Monitoring. namespace : l'espace de noms du service Alibaba Cloud. metric_list : les métriques du service Alibaba Cloud.	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total
CreateTime	string	L'horodatage de création de la tâche d'importation de métriques.	1639382496000
TaskName	string	Le nom de la tâche d'importation de métriques.	aliyun_task
Namespace	string	L'espace de noms auquel l'hôte appartient.	aliyun
UploadRegion	string	La région où réside l'hôte.	cn-hangzhou
NetworkType	string	Le type de réseau de l'hôte. Valeurs valides :	vpc
CollectTimout	integer	Le délai d'expiration pendant lequel l'agent CloudMonitor collecte les données de surveillance de l'hôte. Valeurs valides : 0 15 30 60 Unité : secondes.	15
CollectTargetEndpoint	string	L'URL de la destination à partir de laquelle l'agent CloudMonitor collecte les données de surveillance de l'hôte.	http://localhost
TaskType	string	Le type de la tâche d'importation de métriques. Valeurs valides : aliyun_fc : tâches d'importation de métriques pour les services Alibaba Cloud aliyun_sls : métriques pour les journaux importés depuis Log Service	aliyun_sls
MatchExpressRelation	string	La relation entre les conditions utilisées pour filtrer les tâches d'importation de métriques. Valeurs valides : or and	or
Description	string	La description de la tâche d'importation de métriques.	aliyun
GroupId	string	L'identifiant du groupe d'applications.	3607****
CollectInterval	integer	L'intervalle auquel l'agent CloudMonitor collecte les données de surveillance de l'hôte. Valeurs valides : 15 30 60 Unité : secondes.	60
TargetUserId	string	L'identifiant du compte membre. Remarque Ce paramètre s'affiche uniquement lorsque vous appelez cette opération à l'aide d'un compte de gestion.	120886317861****
CollectTargetPath	string	Le chemin relatif à partir duquel l'agent CloudMonitor collecte les données de surveillance.	/metrics
CollectTargetType	string	Le type de données de surveillance. Valeurs valides : Spring, Tomcat, Nginx, Tengine, JVM, Redis et MySQL.	nginx
TaskId	string	L'identifiant de la tâche d'importation de métriques.	36****
AttachLabels	array<object>	Les balises de la tâche d'importation de métriques.
	object	Aucun.
Name	string	The tag key.	key1
Value	string	The tag value.	value1
MatchExpress	array<object>	Les conditions utilisées pour faire correspondre les instances du groupe d'applications.
	object	Aucun.
Value	string	The keyword that corresponds to the instance name.	ECS_instance1
Name	string	The instance name.	name
Function	string	The method that is used to match the instance name. Valid values: startWith: starts with a prefix endWith: ends with a suffix all: matches all equals: equals contains: contains notContains: does not contain	all
Instances	array	Les instances où les données de surveillance sont collectées par lots.
	string	L'identifiant de l'instance.	i-hp368focau7dp0hw****
ExtraInfo	string	Les informations supplémentaires de l'instance.	test
LogFilePath	string	Le chemin où sont stockées les données de journal sur site. Les données de journal sur site sont stockées dans le chemin spécifié de l'hôte sur lequel CloudMonitor est déployé. Windows : le chemin du journal doit commencer par une lettre de lecteur. Exemple : `C:\UserData\log\\.Log`. Vous ne pouvez pas spécifier de caractères génériques dans un chemin de journal. Linux : le chemin du journal doit commencer par une barre oblique (/). Exemple : `/home/appdata/log//.log`. Dans cet exemple, `/**/` est utilisé pour faire correspondre tous les fichiers du répertoire appdata.	C:\UserData\log\*.Log
LogSplit	string	Le résultat renvoyé après le découpage des données de journal sur site en fonction du mode de correspondance spécifié. Remarque Les modes de correspondance des données de journal sur site incluent le mode regex complet, le mode délimiteur et le mode JSON.	{"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"}]}}]}
LogProcess	string	La méthode utilisée pour agréger les données de journal locales.	[{"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"}]}]
LogSample	string	L'exemple de journal local.	{"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"]}}
SLSProcess	string	Les configurations des journaux importés depuis Log Service.	{"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"}]}
SLSProcessConfig	object	Les configurations 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	The conditions that are used to filter logs imported from Log Service.
Relation	string	The relationship between multiple filter conditions. Valid values: and (default): Logs are processed only if all filter conditions are met. or: Logs are processed if one of the filter conditions is met.	and
Filters	array<object>	The conditions that are used to filter logs imported from Log Service.
	object	The conditions that are used to filter logs imported from Log Service.
SLSKeyName	string	The name of the key that is used to filter logs imported from Log Service.	host
Operator	string	The method that is used to filter logs imported from Log Service. Valid values: `contain`: contains `notContain`: does not contain `>`: greater than `<`: less than `=`: equal to `! =`: not equal to `>=`: greater than or equal to `<=`: less than or equal to	=
Value	string	The value of the key that is used to filter logs imported from Log Service.	200
Statistics	array<object>	The methods that are used to aggregate logs imported from Log Service.
	object	The method that is used to aggregate logs imported from Log Service.
SLSKeyName	string	The name of the key that is used to aggregate logs imported from Log Service.	name
Function	string	The function that is used to aggregate log data within a statistical period. Valid values: count: counts the number. sum: calculates the total value. avg: calculates the average value. max: calculates the maximum value. min: calculates the minimum value. value: collects samples within the statistical period. countps: calculates the average number of the specified field per second by using the following formula: Counted number of the specified field/Total number of seconds within the statistical period. sumps: calculates the average number of the specified field per second by using the following formula: Total value of the specified field/Total number of seconds within the statistical period. distinct: counts the number of logs where the specified field appears within the statistical period. distribution: counts the number of logs that meet a specified condition within the statistical period. percentile: sorts the values of the specified field in ascending order, and then returns the value that is at the specified percentile within the statistical period. Example: P50.	count
Alias	string	The alias of the aggregation result.	level_count
Parameter1	string	The value of the function that is used to aggregate logs imported from Log Service. If the `Function` parameter is set to `distribution`, this parameter indicates the lower limit of the statistical interval. For example, 200 indicates that the number of HTTP requests whose status code is 2XX is calculated. If the `Function` parameter is set to `percentile`, this parameter specifies the percentile at which the expected value is. For example, 0.5 specifies P50.	200
Parameter2	string	The value of the function that is used to aggregate logs imported from Log Service. Remarque This parameter is returned only if the `Function` parameter is set to `distribution`. This parameter indicates the upper limit of the statistical interval. For example, 299 indicates that the number of HTTP requests whose status code is 2XX is calculated.	299
GroupBy	array<object>	The dimensions based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.
	object	The dimension based on which data is aggregated. This parameter is equivalent to the GROUP BY clause in SQL.
SLSKeyName	string	The name of the key that is used to aggregate logs imported from Log Service.	code
Alias	string	The alias of the aggregation result.	ApiResult
Express	array<object>	The extended fields that indicate the results of basic operations that are performed on aggregation results.
	object	The extended field that indicates the result of basic operations that are performed on aggregation results.
Express	string	The extended field that indicates the result of basic operations that are performed on aggregation results.	success_count
Alias	string	The alias of the extended field that indicates the result of basic operations that are performed on aggregation results.	SuccRate

Exemples

JSON format

{
  "RequestId": "11145B76-566A-5D80-A8A3-FAD98D310079",
  "Success": "true",
  "Code": "200",
  "Message": "success",
  "PageSize": 10,
  "PageNumber": 1,
  "Total": 1,
  "TaskList": [
    {
      "YARMConfig": "products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total",
      "CreateTime": "1639382496000",
      "TaskName": "aliyun_task",
      "Namespace": "aliyun",
      "UploadRegion": "cn-hangzhou",
      "NetworkType": "vpc",
      "CollectTimout": 15,
      "CollectTargetEndpoint": "http://localhost",
      "TaskType": "aliyun_sls",
      "MatchExpressRelation": "or",
      "Description": "aliyun",
      "GroupId": "3607****",
      "CollectInterval": 60,
      "TargetUserId": "120886317861****",
      "CollectTargetPath": "/metrics",
      "CollectTargetType": "nginx",
      "TaskId": "36****",
      "AttachLabels": [
        {
          "Name": "key1",
          "Value": "value1"
        }
      ],
      "MatchExpress": [
        {
          "Value": "ECS_instance1",
          "Name": "name",
          "Function": "all"
        }
      ],
      "Instances": [
        "i-hp368focau7dp0hw****"
      ],
      "ExtraInfo": "test",
      "LogFilePath": "C:\\UserData\\log\\*.Log",
      "LogSplit": "{\"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\"}]}}]}",
      "LogProcess": "[{\"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\"}]}]",
      "LogSample": "{\"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\"]}}",
      "SLSProcess": "{\"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\"}]}",
      "SLSProcessConfig": {
        "Filter": {
          "Relation": "and",
          "Filters": [
            {
              "SLSKeyName": "host",
              "Operator": "=",
              "Value": "200"
            }
          ]
        },
        "Statistics": [
          {
            "SLSKeyName": "name",
            "Function": "count",
            "Alias": "level_count",
            "Parameter1": "200",
            "Parameter2": "299"
          }
        ],
        "GroupBy": [
          {
            "SLSKeyName": "code",
            "Alias": "ApiResult"
          }
        ],
        "Express": [
          {
            "Express": "success_count",
            "Alias": "SuccRate"
          }
        ]
      }
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	%s	%s
500	%s	%s
500	InternalError	%s
403	%s	%s
404	%s	%s

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

Notes de version

Consultez Notes de version pour la liste complète.