DescribeMetricRuleBlackList - - Centre de documentation Alibaba Cloud

Consulte la liste des stratégies de liste noire des alertes.

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

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Namespace	string	Non	L'espace de noms du service Alibaba Cloud. Pour plus d'informations sur les espaces de noms des services Alibaba Cloud, consultez Métriques des services cloud.	acs_ecs_dashboard
PageNumber	integer	Non	Le numéro de page. Valeur par défaut : 1.	1
PageSize	integer	Non	Le nombre d'entrées par page. Valeur par défaut : 10.	100
Order	integer	Non	L'ordre dans lequel les résultats de la requête sont triés par heure. Valeurs valides : 0 : ordre croissant (ASC). 1 : ordre décroissant (DESC). Il s'agit de la valeur par défaut.	1
Category	string	Non	La catégorie du service Alibaba Cloud. Par exemple, ApsaraDB for Redis comprend `kvstore_standard` (édition Standard), `kvstore_sharding` (édition Cluster) et `kvstore_splitrw` (édition avec répartition lecture/écriture).	ecs
Ids	array	Non	Les identifiants des stratégies de liste noire des alertes.
	string	Non	L'identifiant de la stratégie de liste noire des alertes.	a9ad2ac2-3ed9-11ed-b878-0242ac12****
Name	string	Non	Le nom de la stratégie de liste noire des alertes. Ce paramètre prend en charge la correspondance approximative.	Blacklist-01
ScopeType	string	Non	La portée d'application de la stratégie de liste noire des alertes. Valeurs valides : USER : la stratégie de liste noire des alertes prend effet uniquement dans le compte Alibaba Cloud actuel. GROUP : la stratégie de liste noire des alertes prend effet dans les groupes d'applications spécifiés.	USER
IsEnable	boolean	Non	L'état de la stratégie de liste noire des alertes. Valeurs valides : true : activée. false : désactivée.	true
InstanceIds	array	Non	La liste des identifiants d'instance dans la stratégie de liste noire des alertes. Valeurs valides de N : 0 à 10.
	string	Non	L'identifiant de l'instance dans la stratégie de liste noire des alertes.	i-2ze2d6j5uhg20x47****

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

Éléments de réponse

Élément	Type	Description	Exemple
	object	Aucune.
Code	string	Le code d'état. Remarque La valeur 200 indique que l'opération a réussi.	200
Message	string	Le message d'erreur.	The Request is not authorization
RequestId	string	L'identifiant de la requête.	D63E76CB-29AA-5B9F-88CE-400A6F28D428
Total	integer	Le nombre total de stratégies de liste noire des alertes.	1
Success	boolean	Indique si l'opération a réussi. Valeurs valides : true : réussie. false : échouée.	true
DescribeMetricRuleBlackList	array<object>	La liste des stratégies de liste noire des alertes.
	array<object>	La liste des stratégies de liste noire des alertes.
EffectiveTime	string	La période d'application de la stratégie de liste noire des alertes. La valeur est au format HH:mm-HH:mm (horloge 24 heures). Le fuseau horaire par défaut est UTC+8. Par exemple, « 00:00-23:59 » indique que la stratégie prend effet toute la journée.	00:00-23:59
UpdateTime	string	L'horodatage de la dernière modification de la stratégie de liste noire des alertes. Unité : millisecondes.	1665718373000
CreateTime	string	L'horodatage de la création de la stratégie de liste noire des alertes. Unité : millisecondes.	1665714561000
ScopeType	string	La portée d'application de la stratégie de liste noire des alertes. Valeurs valides : USER : la stratégie de liste noire des alertes prend effet uniquement dans le compte Alibaba Cloud actuel. GROUP : la stratégie de liste noire des alertes prend effet dans les groupes d'applications spécifiés.	USER
IsEnable	boolean	L'état de la stratégie de liste noire des alertes. Valeurs valides : true : activée. false : désactivée.	true
Namespace	string	L'espace de noms du service Alibaba Cloud.	acs_ecs_dashboard
Category	string	La catégorie du service Alibaba Cloud. Par exemple, ApsaraDB for Redis comprend `kvstore_standard` (édition Standard), `kvstore_sharding` (édition Cluster) et `kvstore_splitrw` (édition avec répartition lecture/écriture).	ecs
EnableEndTime	integer	L'horodatage de fin de la stratégie de liste noire des alertes. Unité : millisecondes.	1640608200000
Name	string	Le nom de la stratégie de liste noire des alertes.	Blacklist-01
EnableStartTime	integer	L'horodatage de début de la stratégie de liste noire des alertes. Unité : millisecondes.	1640237400000
Id	string	L'identifiant de la stratégie de liste noire des alertes.	93514c96-ceb8-47d8-8ee3-93b6d98b****
Metrics	array<object>	Les métriques de surveillance des instances.
	object	Les métriques de surveillance des instances.
Resource	string	The extension dimension information of the instance. For example, `{"device":"C:"}` indicates that the blacklist policy is applied to all C drives of the ECS instance under the Alibaba Cloud service.	[{"device":"C:"}]
MetricName	string	The name of the monitoring metrics.	disk_utilization
Instances	array	Les instances du service Alibaba Cloud spécifié dans la stratégie de liste noire des alertes.
	string	Les instances du service Alibaba Cloud spécifié dans la stratégie de liste noire des alertes.	i-rj99xc6cptkk64ml****
ScopeValue	array	Les identifiants des groupes d'applications.
	string	Les identifiants des groupes d'applications. La valeur est au format de tableau JSON. Remarque Ce paramètre est renvoyé uniquement lorsque `ScopeType` est défini sur `GROUP`.	["67**","78**"]

Exemples

JSON format

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "D63E76CB-29AA-5B9F-88CE-400A6F28D428",
  "Total": 1,
  "Success": true,
  "DescribeMetricRuleBlackList": [
    {
      "EffectiveTime": "00:00-23:59",
      "UpdateTime": "1665718373000",
      "CreateTime": "1665714561000",
      "ScopeType": "USER",
      "IsEnable": true,
      "Namespace": "acs_ecs_dashboard",
      "Category": "ecs",
      "EnableEndTime": 1640608200000,
      "Name": "Blacklist-01",
      "EnableStartTime": 1640237400000,
      "Id": "93514c96-ceb8-47d8-8ee3-93b6d98b****",
      "Metrics": [
        {
          "Resource": "[{\"device\":\"C:\"}]",
          "MetricName": "disk_utilization"
        }
      ],
      "Instances": [
        "i-rj99xc6cptkk64ml****"
      ],
      "ScopeValue": [
        "[\"67****\",\"78****\"]"
      ]
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

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

Notes de version

Consultez Notes de version pour la liste complète.