Interrogation des instances - - Centre de documentation Alibaba Cloud

Vous pouvez appeler l'opération DescribeDBInstances pour interroger une ou plusieurs instances ApsaraDB RDS qui répondent aux conditions spécifiées.

Utilisez l'une des méthodes suivantes pour vérifier la réponse :

Méthode 1 : utilisez le paramètre MaxResults pour spécifiez le nombre d'entrées par page. Ensuite, utilisez le paramètre NextToken pour indiquer le jeton permettant d'afficher la page suivante. Le paramètre NextToken doit être défini sur la valeur renvoyée par le dernier appel de l'opération DescribeDBInstances pour le paramètre NextToken.

Remarque
Lors du premier appel de l'opération DescribeDBInstances pour effectuer une requête paginée, il vous suffit de spécifiez le paramètre MaxResults. Dans ce cas, l'opération renvoie les données de la première page ainsi que la valeur du paramètre NextToken.
Méthode 2 : utilisez le paramètre PageSize pour spécifiez le nombre d'entrées par page. Ensuite, utilisez le paramètre PageNumber pour afficher la page suivante.

Remarque

Vous ne pouvez utiliser qu'une seule des méthodes précédentes. Si un grand nombre d'entrées sont renvoyées, nous vous recommandons d'utiliser la méthode 1 pour accélérer la requête.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour votre commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. 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	DescribeDBInstances	L'opération que vous souhaitez exécuter. Définissez la valeur sur DescribeDBInstances.
ClientToken	String	Non	ETnLKlblzczshOTUbOCzxxxxxxx	Le jeton client utilisé pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer la valeur, mais vous devez vous assurer qu'elle est unique parmi les différentes requêtes. Le jeton ne peut contenir que des caractères ASCII et ne peut pas dépasser 64 caractères de longueur.
proxyId	String	Non	API	L'ID du mode proxy utilisé sur les instances.
Engine	String	Non	MySQL	Le moteur de base de données exécuté par les instances. Valeurs valides : MySQL SQLServer PostgreSQL MariaDB Par défaut, cette opération renvoie les instances exécutant l'un des moteurs de base de données pris en charge.
ZoneId	String	Non	cn-hangzhou-a	L'ID de la zone à laquelle appartiennent les instances.
ResourceGroupId	String	Non	rg-acfmyxxxxx	L'ID du groupe de ressources auquel appartiennent les instances.
DBInstanceStatus	String	Non	Running	L'état des instances. Pour plus d'informations, consultez le Tableau des états des instances.
Expired	String	Non	True	Indique si les instances ont expiré. Valeurs valides : True : interroge les instances qui ont expiré. False : interroge les instances qui n'ont pas expiré.
SearchKey	String	Non	rm-uf6w	Les mots-clés contenus dans les ID ou les descriptions des instances.
DBInstanceId	String	Non	rm-uf6wjk5xxxxxxx	L'ID de l'instance. Vous pouvez appeler l'opération DescribeDBInstances pour interroger les ID des instances.
DBInstanceType	String	Non	Primary	Le rôle des instances. Valeurs valides : Primary : instance principale Readonly : instance en lecture seule Guard : instance de reprise après sinistre Temp : instance temporaire Par défaut, cette opération renvoie les instances assumant l'un des rôles pris en charge.
RegionId	String	Oui	cn-hangzhou	L'ID de la région dans laquelle résident les instances. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions la plus récente.
PageSize	Integer	Non	30	Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 1 à 100. Valeur par défaut : 30.
PageNumber	Integer	Non	1	Le numéro de la page à renvoyer. Valeurs valides : tout entier positif non nul. Valeur par défaut : 1.
InstanceNetworkType	String	Non	Classic	Le type de réseau des instances. Valeurs valides : VPC Classic Par défaut, cette opération renvoie les instances qui résident dans l'un des types de réseaux pris en charge.
VpcId	String	Non	vpc-uf6f7l4fg90xxxxxxxxxx	L'ID du cloud privé virtuel (VPC) auquel appartiennent les instances.
VSwitchId	String	Non	vsw-uf6adz52c2pxxxxxxxxxx	L'ID du vSwitch.
DBInstanceClass	String	Non	rds.mys2.small	Le type d'instance des instances. Pour plus d'informations, consultez les Types d'instances principales ApsaraDB RDS.
EngineVersion	String	Non	5.7	La version du moteur de base de données exécutée par les instances.
PayType	String	Non	Postpaid	La méthode de facturation des instances. Valeurs valides : Postpaid : paiement à l'utilisation Prepaid : abonnement
ConnectionMode	String	Non	Standard	Le mode de connexion des instances. Valeurs valides : Standard : mode standard Safe : mode proxy de base de données Par défaut, cette opération renvoie les instances fonctionnant dans l'un des modes de connexion pris en charge.
Tags	String	Non	{"key1":"value1"}	Les tags ajoutés à l'instance. Chaque tag est une paire clé-valeur composée de deux parties : TagKey et TagValue. Vous pouvez spécifier un maximum de cinq tags au format suivant pour chaque requête : {"key1":"value1","key2":"value2"...}.
DedicatedHostGroupId	String	Non	dhg-7a9xxxxxxxx	L'ID du cluster dédié auquel appartiennent les instances.
DedicatedHostId	String	Non	i-bpxxxxxxx	L'ID de l'hôte sur lequel résident les instances dans le cluster dédié spécifié.
InstanceLevel	Integer	Non	0	Indique s'il faut renvoyer les éditions RDS des instances à l'aide du paramètre Category. Valeurs valides : 0 : vous souhaitez que les éditions RDS des instances soient renvoyées. 1 : vous ne souhaitez pas que les éditions RDS des instances soient renvoyées.
ConnectionString	String	Non	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com	L'endpoint de l'instance. Vous devez spécifier ce paramètre uniquement lorsque vous souhaitez interroger une seule instance.
NextToken	String	Non	o7PORW5o2TJg**********	Le jeton utilisé pour afficher la page suivante. Vous devez définir ce paramètre sur la valeur renvoyée par le dernier appel de l'opération DescribeDBInstances pour le paramètre NextToken. Si les entrées renvoyées sont affichées sur plusieurs pages, la page suivante peut être affichée lorsque vous appelez à nouveau cette opération avec ce paramètre spécifié.
MaxResults	Integer	Non	30	Le nombre d'entrées à renvoyer sur chaque page. Valeurs valides : 1 à 100. Valeur par défaut : 30. Remarque Si vous spécifiez ce paramètre, les paramètres PageSize et PageNumber ne sont pas disponibles.

Paramètres de la réponse

Paramètre	Type	Exemple	Description
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	ID de la requête.
PageNumber	Integer	1	Numéro de la page renvoyée. Remarque Si vous spécifiez le paramètre MaxResults ou le paramètre NextToken, seule la valeur 1 est renvoyée. Vous pouvez ignorer cette valeur.
PageRecordCount	Integer	10	Nombre d'entrées renvoyées sur la page actuelle.
TotalRecordCount	Integer	100	Nombre total d'entrées renvoyées. Remarque Si vous spécifiez le paramètre MaxResults ou le paramètre NextToken, seul le nombre d'entrées de la page actuelle est renvoyé. Vous pouvez ignorer ce nombre.
Items	Array of DBInstance		Détails des instances.
DBInstance
VpcId	String	vpc-uf6f7l4fg90xxxxxxx	ID du VPC auquel l'instance appartient.
DedicatedHostIdForLog	String	dh-bpxxxx	ID de l'hôte sur lequel réside l'instance de journalisation.
CreateTime	String	2018-11-05T11:26:02Z	Heure de création de l'instance. L'heure respecte la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ et s'affiche en UTC.
PayType	String	Postpaid	Méthode de facturation de l'instance. Valeurs possibles : Postpaid : paiement à l'utilisation Prepaid : abonnement
DedicatedHostNameForLog	String	testlog	Nom de l'hôte sur lequel réside l'instance de journalisation.
MutriORsignle	Boolean	true	Indique si la méthode de déploiement multi-zone est utilisée pour l'instance. Valeurs possibles : true et false. Remarque Si la méthode de déploiement multi-zone est utilisée pour l'instance, l'ID de zone de l'instance contient MAZ. Exemple : `cn-hangzhou-MAZ10(h,i)`.
DedicatedHostGroupName	String	testhostgroup	Nom du cluster dédié auquel l'instance appartient.
EngineVersion	String	5.7	Version du moteur de base de données exécutée par l'instance.
DedicatedHostGroupId	String	dhg-7a9xxxxxxxx	ID du cluster dédié auquel l'instance appartient.
VpcName	String	test-huadong	Nom du VPC auquel l'instance appartient.
DedicatedHostZoneIdForMaster	String	cn-hangzhou-c	ID de la zone à laquelle l'instance principale appartient.
ConnectionString	String	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com	Endpoint de l'instance.
InstanceNetworkType	String	Classic	Type de réseau de l'instance. Valeurs possibles : Classic VPC
MasterInstanceId	String	rm-uf6wjk5xxxxxxxxxx	ID de l'instance principale. Si la valeur de ce paramètre est nulle, l'instance est une instance principale.
ExpireTime	String	2019-02-27T16:00:00Z	Heure d'expiration de l'instance. L'heure respecte la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ et s'affiche en UTC. Remarque Les instances en paiement à l'utilisation n'expirent jamais.
DestroyTime	String	2018-11-05T11:26:02Z	Heure de destruction de l'instance. L'heure respecte la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ et s'affiche en UTC.
GuardDBInstanceId	String	rm-uf64zsuxxxxxxxxxx	ID de l'instance de reprise après sinistre. Ce paramètre est renvoyé uniquement lorsque l'instance est une instance principale et possède une instance de reprise après sinistre.
DedicatedHostNameForMaster	String	testmaster	Nom de l'hôte sur lequel réside l'instance principale.
ZoneId	String	cn-hangzhou-a	ID de la zone à laquelle l'instance appartient.
DBInstanceId	String	rm-uf6wjk5xxxxxxxxxx	ID de l'instance.
DedicatedHostIdForMaster	String	dh-bpxxxx	ID de l'hôte sur lequel réside l'instance principale.
TempDBInstanceId	String	rm-uf64zsuxxxxxxxxxx	ID de l'instance temporaire. Ce paramètre est renvoyé uniquement lorsque l'instance est une instance principale et possède une instance temporaire.
DBInstanceStorageType	String	ModuleList.4.ModuleCode	Type de stockage de l'instance.
ConnectionMode	String	Standard	Mode de connexion de l'instance. Valeurs possibles : Standard : mode standard Safe : mode proxy de base de données
LockMode	String	Unlock	Indique si l'instance est verrouillée. Valeurs possibles : Unlock : l'instance n'est pas verrouillée. ManualLock : l'instance est verrouillée manuellement. LockByExpiration : l'instance est automatiquement verrouillée après expiration. LockByRestoration : l'instance est automatiquement verrouillée avant restauration. LockByDiskQuota : l'instance est automatiquement verrouillée lorsque la capacité de stockage est épuisée. Released : l'instance est libérée. Une fois une instance libérée, elle ne peut plus être déverrouillée. Vous pouvez uniquement restaurer les données de sauvegarde de l'instance vers une nouvelle instance. Cette opération prend beaucoup de temps.
VpcCloudInstanceId	String	rm-uf6wjk5xxxxxxx	ID de l'instance. Ce paramètre est renvoyé uniquement lorsque l'instance réside dans un VPC.
DedicatedHostZoneIdForSlave	String	cn-hangzhou-d	ID de la zone à laquelle l'instance secondaire appartient.
DedicatedHostZoneIdForLog	String	cn-hangzhou-b	ID de la zone de l'hôte sur lequel réside l'instance de journalisation.
DedicatedHostNameForSlave	String	testslave	Nom de l'hôte sur lequel réside l'instance secondaire.
DBInstanceDescription	String	testdatabase	Description de l'instance.
DBInstanceNetType	String	Internet	Type de connexion réseau à l'instance. Valeurs possibles : Internet : Internet Intranet : réseau interne
DBInstanceType	String	Primary	Rôle de l'instance. Valeurs possibles : Primary : instance principale Readonly : instance en lecture seule Guard : instance de reprise après sinistre Temp : instance temporaire
LockReason	String	instance_expired	Raison du verrouillage de l'instance.
DBInstanceStatus	String	Running	Statut de l'instance. Pour plus d'informations, consultez le Tableau des états des instances.
RegionId	String	cn-hangzhou	ID de la région de l'instance.
VSwitchId	String	vsw-uf6adz52c2pxxxxxxx	ID du vSwitch.
DedicatedHostIdForSlave	String	dh-bpxxxx	ID de l'hôte sur lequel réside l'instance secondaire.
ResourceGroupId	String	rg-acfmyxxxxxxx	ID du groupe de ressources auquel l'instance appartient.
Category	String	Basic	Édition RDS de l'instance. Valeurs possibles : Basic : Édition de base HighAvailability : Édition haute disponibilité Finance : Édition Enterprise Remarque Ce paramètre est renvoyé uniquement lorsque le paramètre InstanceLevel est défini sur 1.
Engine	String	MySQL	Moteur de base de données exécuté par l'instance.
DBInstanceClass	String	rds.mys2.small	Type d'instance de l'instance. Pour plus d'informations, consultez les Types d'instances principales ApsaraDB RDS.
ReadOnlyDBInstanceIds	Array of ReadOnlyDBInstanceId		Tableau contenant les ID des instances en lecture seule associées à l'instance. Ce paramètre est renvoyé uniquement lorsque l'instance est une instance principale et possède des instances en lecture seule.
ReadOnlyDBInstanceId
DBInstanceId	String	rr-uf6wjk5xxxxxxx	ID de l'instance en lecture seule.
DeletionProtection	Boolean	false	Indique si la fonctionnalité de protection contre la suppression est activée pour l'instance en lecture seule. Valeurs possibles : true : la fonctionnalité de protection contre la suppression est activée. false : la fonctionnalité de protection contre la suppression est désactivée.
NextToken	String	o7PORW5o2TJg**********	Jeton utilisé pour afficher la page suivante. Si les entrées renvoyées sont affichées sur plusieurs pages, la page suivante peut être affichée lors d'un nouvel appel à cette opération avec le paramètre NextToken spécifié.

Exemples

Exemple de requête

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

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

<DescribeDBInstancesResponse>
    <TotalRecordCount>1</TotalRecordCount>
    <PageRecordCount>1</PageRecordCount>
    <RequestId>A436D75C-30B0-1F34-8544-4B46F4407CC1</RequestId>
    <NextToken>o7PORW5owHNg**********</NextToken>
    <PageNumber>1</PageNumber>
    <Items>
        <DBInstance>
            <EngineVersion>10.0</EngineVersion>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <ResourceGroupId>rg-acfmyiu********</ResourceGroupId>
            <DBInstanceNetType>Intranet</DBInstanceNetType>
            <DBInstanceClass>pg.n2.small.2c</DBInstanceClass>
            <CreateTime>2021-02-02T09:14:48Z</CreateTime>
            <VSwitchId>vsw-bp10aqj6o4lcl********</VSwitchId>
            <TipsLevel>0</TipsLevel>
            <DBInstanceType>Primary</DBInstanceType>
            <PayType>Prepaid</PayType>
            <LockMode>Unlock</LockMode>
            <DeletionProtection>false</DeletionProtection>
            <MutriORsignle>false</MutriORsignle>
            <InstanceNetworkType>VPC</InstanceNetworkType>
            <InsId>1</InsId>
            <VpcId>vpc-bp1opxu1zkhn0********</VpcId>
            <DBInstanceId>pgm-bp10re7n********</DBInstanceId>
            <ConnectionMode>Standard</ConnectionMode>
            <ReadOnlyDBInstanceIds>
            </ReadOnlyDBInstanceIds>
            <VpcCloudInstanceId>pgm-bp10re7n********</VpcCloudInstanceId>
            <RegionId>cn-hangzhou</RegionId>
            <ConnectionString>pgm-bp10re7n**************.pg.rds.aliyuncs.com</ConnectionString>
            <ExpireTime>2021-02-03T09:14:48Z</ExpireTime>
            <Engine>PostgreSQL</Engine>
        </DBInstance>
    </Items>
</DescribeDBInstancesResponse>

Format JSON

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

{
  "TotalRecordCount" : 1,
  "PageRecordCount" : 1,
  "RequestId" : "A436D75C-30B0-1F34-8544-4B46F4407CC1",
  "NextToken" : "o7PORW5owHNg**********",
  "PageNumber" : 1,
  "Items" : {
    "DBInstance" : [ {
      "EngineVersion" : "10.0",
      "ZoneId" : "cn-hangzhou-h",
      "DBInstanceStatus" : "Running",
      "ResourceGroupId" : "rg-acfmyiu********",
      "DBInstanceNetType" : "Intranet",
      "DBInstanceClass" : "pg.n2.small.2c",
      "CreateTime" : "2021-02-02T09:14:48Z",
      "VSwitchId" : "vsw-bp10aqj6o4lcl********",
      "TipsLevel" : 0,
      "DBInstanceType" : "Primary",
      "PayType" : "Prepaid",
      "LockMode" : "Unlock",
      "DeletionProtection" : false,
      "MutriORsignle" : false,
      "InstanceNetworkType" : "VPC",
      "InsId" : 1,
      "VpcId" : "vpc-bp1opxu1zkhn0********",
      "DBInstanceId" : "pgm-bp10re7n********",
      "ConnectionMode" : "Standard",
      "ReadOnlyDBInstanceIds" : {
        "ReadOnlyDBInstanceId" : [ ]
      },
      "VpcCloudInstanceId" : "pgm-bp10re7n********",
      "RegionId" : "cn-hangzhou",
      "ConnectionString" : "pgm-bp10re7n**************.pg.rds.aliyuncs.com",
      "ExpireTime" : "2021-02-03T09:14:48Z",
      "Engine" : "PostgreSQL"
    } ]
  }
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
400	Invalid.NextToken	The parameter NextToken is invalid.	Le message d'erreur indique que la valeur du paramètre NextToken n'est pas valide.
400	InvalidDBInstanceType.ValueNotSupport	The specified parameter"DBInstanceType" is not valid.	Le message d'erreur indique que le type d'instance spécifié n'est pas valide. Vous devez spécifier un type d'instance valide.

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