CreateHybridMonitorTask - - Centre de documentation Alibaba Cloud

Prérequis

Le service Hybrid Cloud Monitoring est activé. Pour plus d'informations, consultez la rubrique Activer Hybrid Cloud Monitoring.
Pour créer une métrique à partir des journaux importés depuis Log Service, assurez-vous d'avoir activé Log Service et créé un projet ainsi qu'un Logstore. Pour plus d'informations, consultez la rubrique Guide de démarrage rapide.

Notes d'utilisation

Cette rubrique présente un exemple de création d'une tâche d'importation de métriques nommée aliyun_task pour Elastic Compute Service (ECS). La tâche importe la métrique cpu_total dans le namespace aliyun. La réponse confirme la création de la tâche.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer pour plus de commodité. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	CreateHybridMonitorTask	Opération à effectuer. Définissez la valeur sur CreateHybridMonitorTask.
Namespace	String	Oui	aliyun	Nom du namespace. Pour obtenir le nom d'un namespace, consultez la rubrique DescribeHybridMonitorNamespaceList.
Description	String	Non	La tâche d'importation de métriques pour un service Alibaba Cloud	Description de la tâche d'importation de métriques.
TaskName	String	Non	aliyun_task	Nom de la tâche d'importation de métriques. Si le paramètre `TaskType` est défini sur `aliyun_fc`, saisissez le nom de la tâche d'importation de métriques. Si le paramètre `TaskType` est défini sur `aliyun_sls`, saisissez le nom de la métrique pour les journaux importés depuis Log Service.
TaskType	String	Oui	aliyun_fc	Indique s'il faut créer une tâche d'importation de métriques pour un service Alibaba Cloud ou une métrique pour les journaux importés depuis Log Service. Valeurs possibles : aliyun_fc : crée une tâche d'importation de métriques pour un service Alibaba Cloud aliyun_sls : crée une métrique pour les journaux importés depuis Log Service
CollectTargetType	String	Oui	aliyun_fc	Type de la cible de collecte. Si le paramètre `TaskType` est défini sur `aliyun_fc`, saisissez `aliyun_fc`. Si le paramètre `TaskType` est défini sur `aliyun_sls`, saisissez le nom du groupe de Logstore.
CollectInterval	String	Non	60	Intervalle de collecte des métriques. Valeurs possibles : 15 60 (valeur par défaut) Unité : secondes. Remarque Ce paramètre est requis uniquement si le paramètre `TaskType` est défini sur `aliyun_sls`.
GroupId	String	Non	3607****	ID du groupe d'applications. Pour obtenir l'ID d'un groupe d'applications, consultez la rubrique DescribeMonitorGroups. Remarque Ce paramètre est requis uniquement si le paramètre `TaskType` est défini sur `aliyun_sls`.
YARMConfig	String	Non	products:- namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total	Fichier de configuration du service Alibaba Cloud que vous souhaitez superviser à l'aide de Hybrid Cloud Monitoring. namespace : namespace du service Alibaba Cloud. Pour interroger le namespace d'un service Alibaba Cloud, consultez la rubrique DescribeMetricMetaList. metric_list : métriques du service Alibaba Cloud. Pour interroger les métriques d'un service Alibaba Cloud, consultez la rubrique DescribeMetricMetaList. Le code suivant montre un exemple de fichier de configuration : `products: - namespace: acs_ecs_dashboard metric_info: - metric_list: - cpu_total - cpu_idle - diskusage_utilization - CPUUtilization - DiskReadBPS - InternetOut - IntranetOut - cpu_system - namespace: acs_rds_dashboard metric_info: - metric_list: - MySQL_QPS - MySQL_TPS` Remarque Ce paramètre est requis uniquement si le paramètre `TaskType` est défini sur `aliyun_fc`.
TargetUserId	String	Non	120886317861****	ID du compte membre. Si vous appelez des opérations API à l'aide d'un compte de gestion, vous pouvez connecter les services Alibaba Cloud activés pour un compte membre dans un annuaire de ressources à Hybrid Cloud Monitoring. Vous pouvez utiliser l'annuaire de ressources pour superviser les services Alibaba Cloud across les comptes d'entreprise. Remarque Ce paramètre est requis uniquement si le paramètre `TaskType` est défini sur `aliyun_fc`.
AttachLabels.N.Value	String	Non	testValue	Valeur du tag de la métrique.
AttachLabels.N.Name	String	Non	app_service	Clé du tag de la métrique.
TargetUserIdList	String	Non	120886317861****	ID des comptes membres. Séparez les ID de plusieurs comptes membres par des virgules (,). Remarque Ce paramètre est requis uniquement si vous appelez cette opération à l'aide du compte de gestion.
SLSProcessConfig	Object	Non		Configuration des journaux importés depuis Log Service. Remarque Ce paramètre est requis uniquement si le paramètre `TaskType` est défini sur `aliyun_sls`.
Filter	Object	Non		Conditions utilisées pour filtrer les journaux importés depuis Log Service.
Relation	String	Non	and	Relation entre plusieurs conditions de filtre. Valeurs possibles : and (valeur par défaut) : les journaux sont traités uniquement si toutes les conditions de filtre sont remplies. or : les journaux sont traités si l'une des conditions de filtre est remplie.
Filters	Array	Non		Conditions utilisées pour filtrer les journaux importés depuis Log Service.
SLSKeyName	String	Non	code	Nom de la clé utilisée pour filtrer les journaux importés depuis Log Service.
Operator	String	Non	=	Méthode utilisée pour filtrer les 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	Non	200	Valeur de la clé utilisée pour filtrer les journaux importés depuis Log Service.
Statistics	Array	Non		Méthode utilisée pour agréger les journaux importés depuis Log Service.
SLSKeyName	String	Non	name	Nom de la clé utilisée pour agréger les journaux importés depuis Log Service.
Function	String	Non	count	Fonction utilisée pour agréger les données de journal au cours d'une période statistique. Valeurs possibles : count : compte le nombre. sum : calcule la valeur totale. avg : calcule la valeur moyenne. max : sélectionne la valeur maximale. min : sélectionne la valeur minimale. value : collecte des échantillons au cours de la période statistique. countps : calcule le nombre compté du champ spécifié divisé par le nombre total de secondes au cours de la période statistique. sumps : calcule la valeur totale du champ spécifié divisée par le nombre total de secondes au cours de la période statistique. distinct : compte le nombre de journaux où le champ spécifié apparaît au cours de la période statistique. distribution : compte le nombre de journaux répondant à une condition spécifiée au cours de la période statistique. percentile : trie les valeurs du champ spécifié par ordre croissant, puis renvoie la valeur située au centile spécifié au cours de la période statistique. Exemple : P50.
Alias	String	Non	level_count	Alias du résultat d'agrégation.
Parameter1	String	Non	200	Valeur de la fonction utilisée pour agréger les journaux importés depuis Log Service. Si vous définissez le paramètre `Function` sur `distribution`, ce paramètre spécifie la limite inférieure de l'intervalle statistique. Par exemple, si vous souhaitez calculer le nombre de requêtes HTTP dont le code d'état est 2XX, définissez ce paramètre sur 200. Si vous définissez le paramètre `Function` sur `percentile`, ce paramètre spécifie le centile auquel se trouve la valeur attendue. Par exemple, 0,5 spécifie P50.
Parameter2	String	Non	299	Valeur de la fonction utilisée pour agréger les journaux importés depuis Log Service. Remarque Ce paramètre est requis uniquement si le paramètre `Function` est défini sur `distribution`. Ce paramètre spécifie la limite supérieure de l'intervalle statistique. Par exemple, si vous souhaitez calculer le nombre de requêtes HTTP dont le code d'état est 2XX, définissez ce paramètre sur 299.
GroupBy	Array	Non		Dimension selon laquelle les données sont agrégées. Ce paramètre équivaut à la clause GROUP BY en SQL.
SLSKeyName	String	Non	code	Nom de la clé utilisée pour agréger les journaux importés depuis Log Service.
Alias	String	Non	ApiResult	Alias du résultat d'agrégation.
Express	Array	Non		Champs étendus qui spécifient les résultats des opérations de base effectuées sur les résultats d'agrégation.
Express	String	Non	success_count	Champ étendu qui spécifie le résultat des opérations de base effectuées sur les résultats d'agrégation.
Alias	String	Non	SuccRate	Alias du champ étendu qui spécifie le résultat des opérations de base effectuées sur les résultats d'agrégation.

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

Paramètres de réponse

Paramètre	Type	Exemple	Description
Code	String	200	Code d'état HTTP. Remarque Le code d'état 200 indique que l'appel a réussi.
Message	String	yamlConfigFail	Message d'erreur.
RequestId	String	28CEA2E0-3E90-51B2-A7E8-B1ED75534E49	ID de la requête.
Success	String	true	Indique si l'appel a réussi. Valeurs possibles : true : l'appel a réussi. false : l'appel a échoué.
TaskId	Long	36****	ID de la tâche d'importation de métriques.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=CreateHybridMonitorTask
&Namespace=aliyun
&TaskName=aliyun_task
&TaskType=aliyun_fc
&YARMConfig=products:
- namespace: acs_ecs_dashboard
  metric_info:
  - metric_list:
    - cpu_total
&<Common request parameters>

Exemple de réponse réussie

Format XML

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

<CreateHybridMonitorTaskResponse>
	<TaskId>36****</TaskId>
	<RequestId>28CEA2E0-3E90-51B2-A7E8-B1ED75534E49</RequestId>
	<Code>200</Code>
	<Success>true</Success>
</CreateHybridMonitorTaskResponse>

Format JSON

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

{
  "TaskId" : "36****",
  "RequestId" : "28CEA2E0-3E90-51B2-A7E8-B1ED75534E49",
  "Code" : 200,
  "Success" : true
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.