GetInstanceInspections - - Centre de documentation Alibaba Cloud

Consulte le résultat d'une inspection effectuée sur une instance de base de données à l'aide de la fonctionnalité d'inspection et de notation.

Description de l'opération

Database Autonomy Service (DAS) fournit la fonctionnalité d'inspection et de notation. Cette fonctionnalité vous permet d'inspecter et de noter régulièrement l'état de santé de votre instance. Cela vous aide à obtenir des informations sur l'état de vos bases de données. Pour plus d'informations, consultez Inspection et notation.

Avant d'appeler cette opération, prenez note des éléments suivants :

Cette opération s'applique uniquement aux bases de données ApsaraDB RDS for MySQL, aux bases de données MySQL auto-gérées hébergées sur des instances Elastic Compute Service (ECS), aux bases de données MySQL auto-gérées dans des centres de données, aux bases de données ApsaraDB for Redis et aux bases de données PolarDB for MySQL.
Si vous utilisez un SDK Alibaba Cloud, assurez-vous que la version d'aliyun-sdk-core est postérieure à V4.3.3. Nous vous recommandons d'utiliser la version la plus récente.
La version du SDK DAS doit être V1.0.3 ou ultérieure.
Si vous utilisez un SDK pour appeler des opérations de DAS, vous devez définir l'identifiant de la région sur cn-shanghai.

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.

hdm:GetInstanceInspections

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Engine	string	Oui	Le moteur de base de données. Valeurs valides : MySQL Redis PolarDBMySQL	MySQL
StartTime	string	Oui	Le début de la plage de temps à interroger. Définissez ce paramètre sur un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC.	1655416825000
EndTime	string	Oui	La fin de la plage de temps à interroger. Définissez ce paramètre sur un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970 à 00:00:00 UTC. Remarque L'heure de fin doit être postérieure à l'heure de début.	1655427625000
PageNo	string	Oui	Le numéro de page. La valeur doit être un entier positif. Valeur par défaut : 1.	1
PageSize	string	Oui	Le nombre d'entrées par page. Valeur par défaut : 10.	10
InstanceArea	string	Oui	Le type d'instance sur laquelle la base de données est déployée. Valeurs valides : RDS : une instance de base de données Alibaba Cloud. ECS : une instance ECS sur laquelle une base de données auto-gérée est déployée. IDC : une instance de base de données auto-gérée qui n'est pas déployée sur Alibaba Cloud. Remarque La valeur IDC indique que l'instance est déployée dans un centre de données.	RDS
SearchMap	string	Non	La condition de filtre, qui peut être spécifiée dans l'un des formats suivants : Spécifiez l'identifiant d'une instance unique au format {"InstanceId":"Identifiant de l'instance"}. Spécifiez les identifiants de plusieurs instances au format {"InstanceIds":["Identifiant d'instance1","Identifiant d'instance2"]}. Séparez les identifiants d'instance par des virgules (,). Spécifiez la région dans laquelle l'instance réside au format {"region":"Région de l'instance"}.	{"InstanceId":"rm-bp10usoc1erj7****"}
ResourceGroupId	string	Non	L'identifiant du groupe de ressources.	rg-aek2eil6npi****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
Message	string	Le message renvoyé. Remarque Si la requête a réussi, Successful est renvoyé. Si la requête a échoué, un message d'erreur tel qu'un code d'erreur est renvoyé.	Successful
RequestId	string	L'identifiant de la requête.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Data	object	Les détails.
List	array<object>	Les informations détaillées.
	array<object>
EndTime	integer	The end time of the inspection and scoring task. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Remarque The end time must be later than the start time.	1608888296001
StartTime	integer	The start time of the inspection and scoring task. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1608888296000
Data	object	The data returned.	"data": { "hasDeadLock": false, "exceptionTableMap": {}, "bigTransactionCount": 0, "cpu": 4, "isRds": true, "rdsEnable": true, "enable": false, "activeSessions": [], "bigTransactionList": [], "bigSessionList": [ { "blockDuration": 0, "active": false, "Time": 0, "db": "" },
Instance	object	The information about the instance.
VpcId	string	The ID of the virtual private cloud (VPC) in which the instance is deployed.	vpc-bp1knt7m55z9exoo7****
Uuid	string	The unique identifier of the instance.	hdm_3063db6792965c080a4bcb6e6304****
InstanceArea	string	The type of the instance on which the database is deployed. Valid values: RDS: an Alibaba Cloud database instance. ECS: an Elastic Compute Service (ECS) instance on which a self-managed database is deployed. IDC: a self-managed database instance that is not deployed on Alibaba Cloud. Remarque The value IDC indicates that the instance is deployed in a data center.	RDS
InstanceClass	string	The instance type.	rds.mysql.s2.xlarge
Region	string	The region ID of the instance.	cn-hangzhou
AccountId	string	The account ID. You can view the ID of the logon account by moving the pointer over the profile in the Alibaba Cloud management console.	108398049688****
NetworkType	string	The network type of the instance.	VPC
Engine	string	The database engine. Valid values: MySQL Redis PolarDBMySQL	MySQL
InstanceId	string	The instance ID.	rm-bp10usoc1erj7****
NodeId	string	The ID of the node on the instance.	rm-bp10usoc1erj7****
EngineVersion	string	The version number of the database engine.	8.0
InstanceAlias	string	The instance name.	test-01
Cpu	string	The CPU specification of the instance. For example, if a value of 8 is returned, the instance has eight CPU cores.	8
Memory	integer	The memory capacity of the database that is deployed on the instance. Unit: MB.	32768
Storage	integer	The storage space of the instance. Unit: GB.	150
Category	string	The connection mode of the instance. Valid values: standard: standard mode. safe: database proxy mode.	standard
ScoreMap	object	The scores that are deducted for the instance.
GmtCreate	integer	The time when the task was created. The value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1603247192000
Score	integer	The inspection score of the instance.	100
AutoFunction	object	Indicates whether the autonomy service is enabled.
EventSubscription	integer	Indicates whether the event subscription feature is enabled. Valid values: 0: disabled. 1: enabled. 2: not supported.	0
AutoIndex	integer	Indicates whether the feature of automatically creating and deleting indexes is enabled. Valid values: 0: disabled. 1: enabled. 2: not supported.	2
AutoLimitedSql	integer	Indicates whether the automatic throttling feature is enabled. Valid values: 0: disabled. 1: enabled. 2: not supported.	2
AutoResourceOptimize	integer	Indicates whether the automatic fragment recycling feature is enabled. Valid values: 0: disabled. 1: enabled. 2: not supported.	0
AutoScale	integer	Indicates whether the auto scaling feature is enabled. Valid values: 0: disabled. 1: enabled. 2: not supported.	0
EnableDasPro	integer	Indicates whether DAS Enterprise Edition is enabled. Valid values: 0: disabled. 1: enabled. 2: not supported.	0
State	integer	The state of the inspection and scoring task. Valid values: 0: The task is waiting for execution. 1: The task is in progress. 2: The task is complete.	2
TaskType	integer	The mode in which the inspection and scoring task was initiated. Valid values: 0: automatic mode. 1: manual mode.	0
PageNo	integer	Le numéro de page. La valeur renvoyée est un entier positif. Valeur par défaut : 1.	1
PageSize	integer	Le nombre d'entrées par page. Valeur par défaut : 10.	10
Total	integer	Le nombre total d'entrées renvoyées.	4
Code	string	Le code d'état HTTP renvoyé.	200
Success	string	Indique si la requête a réussi. Valeurs valides : true false	true

Exemples

JSON format

{
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Data": {
    "List": [
      {
        "EndTime": 1608888296001,
        "StartTime": 1608888296000,
        "Data": {
          "test": "test",
          "test2": 1
        },
        "Instance": {
          "VpcId": "vpc-bp1knt7m55z9exoo7****",
          "Uuid": "hdm_3063db6792965c080a4bcb6e6304****",
          "InstanceArea": "RDS",
          "InstanceClass": "rds.mysql.s2.xlarge",
          "Region": "cn-hangzhou",
          "AccountId": "108398049688****",
          "NetworkType": "VPC",
          "Engine": "MySQL",
          "InstanceId": "rm-bp10usoc1erj7****",
          "NodeId": "rm-bp10usoc1erj7****",
          "EngineVersion": "8.0",
          "InstanceAlias": "test-01",
          "Cpu": "8",
          "Memory": 32768,
          "Storage": 150,
          "Category": "standard"
        },
        "ScoreMap": {
          "test": "test",
          "test2": 1
        },
        "GmtCreate": 1603247192000,
        "Score": 100,
        "AutoFunction": {
          "EventSubscription": 0,
          "AutoIndex": 2,
          "AutoLimitedSql": 2,
          "AutoResourceOptimize": 0,
          "AutoScale": 0
        },
        "EnableDasPro": 0,
        "State": 2,
        "TaskType": 0
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "Total": 4
  },
  "Code": "200",
  "Success": "true"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

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

Notes de version

Consultez Notes de version pour la liste complète.