DescribeDBInstancePerformance - - Centre de documentation Alibaba Cloud

Consulte les données de performances d'une instance MongoDB.

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.

dds:DescribeDBInstancePerformance

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

dds:ResourceTag

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance. Remarque NodeId est requis lorsque vous spécifiez l'identifiant d'une instance de cluster fragmenté.	dds-bp2635****
NodeId	string	Non	L'identifiant d'un nœud mongos ou shard dans l'instance de cluster fragmenté. Ce paramètre vous permet de consulter les performances d'un nœud unique. Remarque Disponible uniquement lorsque DBInstanceId est défini sur l'identifiant d'une instance de cluster fragmenté.	d-bp2287****
Key	string	Oui	Les métriques de performances. Pour plus d'informations, consultez Métriques. Remarque Pour spécifier plusieurs métriques, séparez-les par des virgules (,).	CpuUsage
StartTime	string	Oui	Le début de la plage de temps à interroger. Spécifiez l'heure au format yyyy-MM-ddTHH:mmZ. L'heure doit être en UTC.	2022-06-13T10:58Z
EndTime	string	Oui	La fin de la plage de temps à interroger. L'heure de fin doit être postérieure à l'heure de début. Spécifiez l'heure au format yyyy-MM-ddTHH:mmZ. L'heure doit être en UTC.	2022-06-13T11:58Z
RoleId	string	Non	L'identifiant de rôle d'un nœud dans une instance autonome ou de jeu de réplicas. Pour obtenir l'identifiant de rôle, appelez l'opération DescribeReplicaSetRole. Remarque Disponible uniquement lorsque DBInstanceId est défini sur l'identifiant d'une instance autonome ou de jeu de réplicas.	6025****
Interval	string	Non	La granularité des données des métriques de performances en secondes. Valeurs valides : 5, 30, 60, 600, 1800, 3600 et 86400.	60
ReplicaSetRole	string	Non	Le rôle d'un nœud dans une instance autonome ou de jeu de réplicas. Valeurs valides : Primary : le nœud principal. Secondary : un nœud secondaire. Remarque Disponible uniquement lorsque DBInstanceId est défini sur l'identifiant d'une instance autonome ou de jeu de réplicas. Si DBInstanceId est défini sur l'identifiant d'une instance autonome, ce paramètre prend uniquement en charge la valeur Primary.	Primary
SearchId	string	Non	L'identifiant du nœud Search. Remarque Disponible uniquement après l'activation de la fonctionnalité Search pour l'instance.	dds-2zec12675c9e****-search

Éléments de réponse

Élément	Type	Description	Exemple
	object
PerformanceKeys	object
PerformanceKey	array<object>	La liste des métriques de performances.
	array<object>
Key	string	The performance metric.	CpuUsage
Unit	string	The unit of the performance metric.	%
ValueFormat	string	The format of the performance metric values. If a performance metric contains multiple fields, the fields are separated by ampersands (&). For example, if you query the disk space usage, the returned ValueFormat is ins_size&data_size&log_size.	cpu_usage
PerformanceValues	object
PerformanceValue	array<object>	The list of performance metric values.
	object
Value	string	The value of the performance metric.	0.23
Date	string	The time when the performance metric value was generated.	2022-06-13T10:58:00Z
EndTime	string	La fin de la plage de temps à interroger. L'heure est au format yyyy-MM-ddTHH:mmZ. L'heure est affichée en UTC.	2022-06-13T11:58Z
RequestId	string	L'identifiant de la requête.	4A300BC7-6D8F-527F-A2DB-A7768D26E9AC
StartTime	string	Le début de la plage de temps à interroger. L'heure est au format yyyy-MM-ddTHH:mmZ. L'heure est affichée en UTC.	2022-06-13T10:58Z

Exemples

JSON format

{
  "PerformanceKeys": {
    "PerformanceKey": [
      {
        "Key": "CpuUsage",
        "Unit": "%",
        "ValueFormat": "cpu_usage",
        "PerformanceValues": {
          "PerformanceValue": [
            {
              "Value": "0.23",
              "Date": "2022-06-13T10:58:00Z"
            }
          ]
        }
      }
    ]
  },
  "EndTime": "2022-06-13T11:58Z",
  "RequestId": "4A300BC7-6D8F-527F-A2DB-A7768D26E9AC",
  "StartTime": "2022-06-13T10:58Z"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidPerformanceKey.Malformed	The specified parameter Key is not valid.
400	InvalidStartTime.Malformed	The specified parameter StartTime is not valid.
400	InvalidEndTime.Malformed	The specified parameter EndTime is not valid.
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time	The end time cannot be earlier than the start time.

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

Notes de version

Consultez Notes de version pour la liste complète.