DescribeDBClusterHealthStatus - AnalyticDB - Centre de documentation Alibaba Cloud

Consulte l'état de santé d'un cluster.

Description de l'opération

Pour l'adresse d'accès au service, consultez le point de terminaison du service.

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.

adb:DescribeDBClusterHealthStatus

list

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBClusterId	string	Oui	L'identifiant du cluster Data Lakehouse Edition. Remarque Vous pouvez appeler l'opération DescribeDBClusters pour interroger les identifiants des clusters.	amv-uf6o6m8p6x7v****
RegionId	string	Oui	L'identifiant de la région du cluster. Remarque Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions la plus récente.	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object
CS	object	L'état de santé des nœuds d'accès à l'instance.
ActiveCount	integer	Le nombre de nœuds d'accès à l'instance sains.	0
UnavailableCount	integer	Le nombre de nœuds d'accès à l'instance indisponibles.	1
RiskCount	integer	Le nombre de nœuds d'accès à l'instance à risque.	0
ExpectedCount	integer	Le nombre total de nœuds d'accès à l'instance.	1
Status	string	L'état de santé des nœuds d'accès à l'instance. Valeurs valides : RISK : Les nœuds d'accès à l'instance sont à risque. NORMAL : Les nœuds d'accès à l'instance sont sains. UNAVAILABLE : Les nœuds d'accès à l'instance sont indisponibles.	UNAVAILABLE
Executor	object	L'état de santé des groupes d'exécuteurs.
ActiveCount	integer	Le nombre de nœuds d'exécution sains.	0
UnavailableCount	integer	Le nombre de nœuds d'exécution indisponibles.	1
RiskCount	integer	Le nombre de nœuds d'exécution à risque.	0
ExpectedCount	integer	Le nombre total de nœuds d'exécution.	1
Status	string	L'état de santé des groupes d'exécuteurs. Valeurs valides : RISK : Les groupes d'exécuteurs sont à risque. NORMAL : Les groupes d'exécuteurs sont sains. UNAVAILABLE : Les groupes d'exécuteurs sont indisponibles.	UNAVAILABLE
Worker	object	L'état de santé des groupes de nœuds de travail.
ActiveCount	integer	Le nombre de groupes de nœuds de travail sains.	0
UnavailableCount	integer	Le nombre de groupes de nœuds de travail indisponibles.	1
RiskCount	integer	Le nombre de groupes de nœuds de travail à risque.	1
ExpectedCount	integer	Le nombre total de groupes de nœuds de travail.	1
Status	string	L'état de santé des groupes de nœuds de travail. Valeurs valides : RISK : Les groupes de nœuds de travail sont à risque. NORMAL : Les groupes de nœuds de travail sont sains. UNAVAILABLE : Les groupes de nœuds de travail sont indisponibles.	UNAVAILABLE
InstanceStatus	string	L'état de santé du cluster. Valeurs valides : RISK : Le cluster est à risque. NORMAL : Le cluster est sain. UNAVAILABLE : Le cluster est indisponible. Remarque L'état de santé du cluster est considéré comme NORMAL uniquement si les nœuds d'accès à l'instance, les groupes d'exécuteurs et les groupes de nœuds de travail sont tous NORMAL et si l'instance est réactive. Si l'un de ces composants a un état RISK, l'état du cluster est RISK. Si un composant a un état UNAVAILABLE, l'état du cluster est UNAVAILABLE.	NORMAL
RequestId	string	L'identifiant de la requête.	1AD222E9-E606-4A42-BF6D-8A4442913CAV
AccessDeniedDetail	string	Détails de l'échec d'authentification.	Échec de l'authentification

Exemples

JSON format

{
  "CS": {
    "ActiveCount": 0,
    "UnavailableCount": 1,
    "RiskCount": 0,
    "ExpectedCount": 1,
    "Status": "UNAVAILABLE"
  },
  "Executor": {
    "ActiveCount": 0,
    "UnavailableCount": 1,
    "RiskCount": 0,
    "ExpectedCount": 1,
    "Status": "UNAVAILABLE"
  },
  "Worker": {
    "ActiveCount": 0,
    "UnavailableCount": 1,
    "RiskCount": 1,
    "ExpectedCount": 1,
    "Status": "UNAVAILABLE"
  },
  "InstanceStatus": "NORMAL",
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CAV",
  "AccessDeniedDetail": "Authentication failed."
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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

Notes de version

Consultez Notes de version pour la liste complète.