Interroger les détails d'une instance - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de 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

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBInstanceAttribute	Opération à effectuer. Définissez la valeur sur DescribeDBInstanceAttribute.
DBInstanceId	String	Yes	rm-uf6wjk5*****	ID de l'instance. Vous pouvez spécifier jusqu'à 30 ID d'instance dans une seule requête. Si vous spécifiez plusieurs ID d'instance, séparez-les par des virgules (,).
Expired	String	No	False	Indique si l'instance a expiré. Valeurs valides : True : L'instance a expiré. False: L'instance n'a pas expiré.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	ID de la requête.
Items	Array of DBInstanceAttribute		Tableau contenant les détails de l'instance.
DBInstanceAttribute
VpcId	String	vpc-*****	ID du VPC (Virtual Private Cloud).
CreationTime	String	2011-05-30T12:11:04Z	Heure de création de l'instance. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC.
IncrementSourceDBInstanceId	String	rm-uf6wjk5*****	ID de l'instance source des données incrémentielles. Les données incrémentielles d'une instance de reprise après sinistre ou d'une instance en lecture seule proviennent de son instance principale. Si ce paramètre n'est pas renvoyé, l'instance est une instance principale.
MaintainTime	String	00:00Z-02:00Z	Fenêtre de maintenance de l'instance. L'heure est affichée en UTC. Notez que la fenêtre de maintenance affichée dans la console ApsaraDB RDS correspond à la valeur de ce paramètre plus 8 heures.
PayType	String	Postpaid	Méthode de facturation de l'instance. Valeurs valides : Postpaid : paiement à l'utilisation Prepaid : abonnement
AvailabilityValue	String	100,0 %	Statut de disponibilité de l'instance, exprimé en pourcentage.
EngineVersion	String	5,5	Version du moteur de base de données de l'instance.
DedicatedHostGroupId	String	dhg-7a9*****	ID du cluster dédié auquel appartient l'instance.
ConnectionString	String	rm-uf6wjk5*****.mysql.rds.aliyuncs.com	Endpoint interne de l'instance.
SuperPermissionMode	String	Disabled	Indique si l'instance prend en charge les comptes superutilisateur, tels que le compte administrateur système (SA), le compte Active Directory (AD) et le compte hôte. Enable : Les comptes superutilisateur sont pris en charge. Disabled : Les comptes superutilisateur ne sont pas pris en charge.
InstanceNetworkType	String	Classic	Type de réseau de l'instance. Valeurs valides : Classic : réseau classique VPC : VPC
MasterInstanceId	String	rm-uf6wjk5*****	ID de l'instance principale. Remarque Si ce paramètre n'est pas renvoyé, l'instance est l'instance principale.
AutoUpgradeMinorVersion	String	Auto	Méthode utilisée pour mettre à jour la version mineure du moteur de l'instance. Valeurs valides : Auto: mise à jour automatique. Manual : mise à jour manuelle. ApsaraDB RDS met automatiquement à jour la version mineure actuelle du moteur de l'instance uniquement lorsque cette version est obsolète.
ExpireTime	String	2019-03-27T16:00:00Z	Heure d'expiration de l'instance. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ. L'heure est affichée en UTC. Remarque Les instances en paiement à l'utilisation n'expirent jamais.
AccountMaxQuantity	Integer	50	Nombre maximal de comptes pouvant être créés sur l'instance.
MasterZone	String	5454284	ID de la zone de l'instance principale.
GuardDBInstanceId	String	rm-uf64zsu*****	ID de l'instance de reprise après sinistre associée à l'instance.
DBInstanceStorage	Integer	10	Capacité de stockage de l'instance. Unité : Go.
TimeZone	String	Central Standard Time	Fuseau horaire de l'instance.
LatestKernelVersion	String	rds_20201031	Dernière version mineure du moteur prise en charge par l'instance.
TipsLevel	Integer	1	Niveau de gravité de l'exception détectée sur l'instance. Ce paramètre est renvoyé uniquement lorsque l'instance est créée dans un cluster ApsaraDB MyBase exécutant MySQL en édition Standard. Valeurs valides : 1 : L'instance est normale. 2 : Les spécifications des instances en lecture seule ne correspondent pas aux spécifications de l'instance principale. Vous devez ajuster les spécifications de ces instances en fonction de vos besoins métier.
ZoneId	String	cn-hangzhou-a	ID de la zone de l'instance.
MaxConnections	Integer	60	Nombre maximal de connexions simultanées autorisées par l'instance.
DBInstanceId	String	rm-uf6wjk5*****	ID de l'instance.
TempDBInstanceId	String	rm-uf64zsu*****	ID de l'instance temporaire associée à l'instance.
AdvancedFeatures	String	LinkedServer	Fonctionnalités avancées activées pour l'instance. Si plusieurs fonctionnalités avancées sont activées, elles sont séparées par des virgules (,). Ce paramètre est disponible uniquement pour les instances exécutant SQL Server. Valeurs valides : LinkedServer DistributeTransaction
DBInstanceStorageType	String	local_ssd	Type de stockage de l'instance. Valeurs valides : local_ssd et ephemeral_ssd : SSD local cloud_ssd : SSD standard cloud_essd : SSD amélioré
DBInstanceMemory	Long	4096	Capacité mémoire de l'instance. Unité : Mo.
IPType	String	IPv4	Type d'adresse IP. Seules les adresses IPv4 sont prises en charge.
ConsoleVersion	String	2	Type de proxy utilisé par l'instance. Valeurs valides : 1 : proxy partagé 2 : proxy dédié Remarque Nous vous recommandons d'utiliser le paramètre ProxyType au lieu de ce paramètre.
ConnectionMode	String	Standard	Mode de connexion de l'instance. Valeurs valides : Standard : mode standard Safe : mode proxy
Port	String	3306	Numéro de port interne utilisé pour se connecter à l'instance.
LockMode	String	Unlock	Mode de verrouillage de l'instance. Valeurs valides : Unlock : L'instance n'est pas verrouillée. ManualLock : L'instance est verrouillée manuellement. LockByExpiration : L'instance est automatiquement verrouillée en raison de son expiration. LockByRestoration : L'instance est automatiquement verrouillée en raison d'une restauration. LockByDiskQuota : L'instance est automatiquement verrouillée en raison d'un espace de stockage épuisé. LockReadInstanceByDiskQuota : L'instance est une instance en lecture seule automatiquement verrouillée lorsque l'espace disque est plein.
GeneralGroupName	String	TestGroup	Nom du cluster dédié auquel appartient l'instance. Ce paramètre est renvoyé uniquement lorsque l'instance est créée dans un cluster ApsaraDB MyBase exécutant MySQL en édition Standard.
VpcCloudInstanceId	String	vpc-23rsxdf*****	ID VPC de l'instance. Ce paramètre est renvoyé uniquement lorsque l'instance réside dans un VPC.
Collation	String	Chinese_PRC_CI_AS	Interclassement du jeu de caractères de l'instance.
MaxIOPS	Integer	150	Nombre maximal de requêtes d'E/S que l'instance peut traiter par seconde.
MaxIOMBPS	Integer	0MB/s	Débit d'E/S maximal. Unité : Mo/s.
Tips	String	Everything is fine.	Informations concernant l'exception détectée sur l'instance. Ce paramètre est renvoyé uniquement lorsque l'instance est créée dans un cluster ApsaraDB MyBase exécutant MySQL en édition Standard.
SecurityIPList	String	192 168.XX.XX/24	Adresses IP figurant dans la liste d'autorisation d'adresses IP.
SecurityIPMode	String	normal	Mode de liste d'autorisation de l'instance. Valeurs valides : normal : mode de liste d'autorisation standard safety : mode de liste d'autorisation amélioré
DBInstanceClassType	String	s	Famille d'instances à laquelle appartient l'instance. Valeurs valides : s : famille d'instances partagées x : famille d'instances à usage général d : famille d'instances dédiées h : famille d'instances hôtes dédiées
ProxyType	Integer	1	Type de proxy pris en charge par l'instance. Valeurs valides : 0 : L'instance ne prend pas en charge les proxys de base de données. 1 : L'instance prend en charge les proxys partagés, avec lesquels l'instance s'exécute en mode multi-locataire. 2 : L'instance prend en charge les proxys dédiés, avec lesquels l'instance s'exécute en mode mono-locataire.
CurrentKernelVersion	String	rds_20181010	Version mineure du moteur de l'instance.
DBInstanceDescription	String	Test database	Description de l'instance.
DBInstanceCPU	String	2	Nombre de cœurs configurés pour l'instance.
DBInstanceNetType	String	Internet	Type de réseau via lequel l'instance est connectée. Valeurs valides : Internet : Internet Intranet : réseau interne
DBInstanceType	String	Primary	Type de l'instance. Valeurs valides : Primary : instance principale Readonly : instance en lecture seule Guard : instance de reprise après sinistre Temp : instance temporaire
LockReason	String	instance_expired	Raison pour laquelle l'instance est verrouillée.
DBInstanceStatus	String	Running	Statut de l'instance. Pour plus d'informations, consultez le Tableau des états des instances.
DBMaxQuantity	Integer	200	Nombre maximal de bases de données pouvant être créées sur l'instance.
RegionId	String	cn-hangzhou	ID de la région de l'instance.
ReadonlyInstanceSQLDelayedTime	String	30	Latence à laquelle le système réplique les données vers les instances en lecture seule. Le système réplique les données de l'instance principale vers les instances en lecture seule avec la latence spécifiée par le paramètre ReadonlyInstanceSQLDelayedTime. Unité : secondes.
VSwitchId	String	vsw-*****	ID du vSwitch.
ResourceGroupId	String	rg-acfmy*****	ID du groupe de ressources.
Category	String	Basic	Édition RDS de l'instance. Valeurs valides : Basic : Édition de base RDS HighAvailability : Édition haute disponibilité RDS AlwaysOn : Édition Cluster RDS pour SQL Server Finance : Édition Entreprise RDS Serverless_basic : Édition de base sans serveur RDS
DBInstanceClass	String	rds.mys2.small	Type d'instance de l'instance. Pour plus d'informations, consultez les Types d'instances principales ApsaraDB RDS.
Engine	String	MySQL	Moteur de base de données de l'instance. Valeurs valides : MySQL PostgreSQL SQLServer MariaDB
SlaveZones	Array of SlaveZone		Tableau contenant les détails des zones secondaires.
SlaveZone
ZoneId	String	cn-hangzhou-a	ID de la zone.
ReadOnlyDBInstanceIds	Array of ReadOnlyDBInstanceId		Tableau contenant les ID des instances en lecture seule associées à l'instance principale.
ReadOnlyDBInstanceId
DBInstanceId	String	rm-bp*****	ID de l'instance RDS en lecture seule.
Extra	Object		Informations étendues de l'instance.
DBInstanceIds	Array of String	rm-uf6wjk5*****	ID de l'instance.
DeletionProtection	Boolean	true	Indique si la fonctionnalité de protection contre la suppression est activée. Valeurs valides : true : La fonctionnalité est activée. false : La fonctionnalité est désactivée.
ServerlessConfig	Object		Paramètres de l'instance sans serveur.
ScaleMin	double	0,5	Nombre minimal d'unités de capacité RDS (RCU).
ScaleMax	double	8	Nombre maximal de RCU.
AutoPause	Boolean	true	Indique si la fonctionnalité de démarrage et d'arrêt automatiques est activée pour l'instance sans serveur. Valeurs valides : true : La fonctionnalité est activée. false : La fonctionnalité est désactivée. Il s'agit de la valeur par défaut. Remarque Une fois la fonctionnalité de démarrage et d'arrêt activée, si aucune connexion à l'instance n'est établie dans les 10 minutes, l'instance est suspendue. Lorsqu'une connexion est établie avec l'instance, celle-ci reprend automatiquement son activité.
SwitchForce	Boolean	false	Indique si la fonctionnalité de mise à l'échelle forcée est activée pour l'instance sans serveur. true : La fonctionnalité est activée. false : La fonctionnalité est désactivée. Il s'agit de la valeur par défaut. Remarque Dans la plupart des cas, ApsaraDB RDS ajuste automatiquement le nombre de RCU d'une instance sans serveur en temps réel en fonction des besoins métier. Dans certains cas, la mise à l'échelle ne prend pas effet immédiatement. Vous pouvez activer la fonctionnalité de mise à l'échelle forcée pour forcer la mise à l'échelle horizontale ou verticale des RCU de l'instance.
BabelfishConfig	Object		Configuration de Babelfish pour l'instance. Remarque Ce paramètre convient uniquement aux instances ApsaraDB RDS for PostgreSQL pour lesquelles Babelfish est activé. Pour plus d'informations, consultez l'Introduction à Babelfish.
BabelfishEnabled	String	true	Commutateur permettant d'activer ou de désactiver Babelfish. Remarque Si Babelfish est activé lors de l'achat d'une instance ApsaraDB RDS for PostgreSQL, ce paramètre est fixé à true.
MigrationMode	String	single-db	Mode de migration pour Babelfish. Valeurs valides : single-db multi-db Remarque Pour plus d'informations sur les modes de migration pour Babelfish, consultez les Modes de migration.
kindCode	String	None	Paramètre interne. Cette opération ne renvoie aucune valeur pour ce paramètre.
InstructionSetArch	String	x86	Type d'architecture de l'instance. Valeurs valides : x86 arm
DBClusterNodes	Array of DBClusterNode		Informations sur le nœud du cluster.
DBClusterNode
NodeRegionId	String	cn-beijing	ID de la région.
NodeZoneId	String	cn-beijing-h	ID de la zone de l'instance.
NodeId	String	rn-****	ID du nœud.
NodeRole	String	primary	Rôle du nœud. Valeurs valides : primary : nœud principal secondary : nœud secondaire
ClassCode	String	mysql.n2.medium.xc	Type de nœud du nœud.

Exemples

Exemples de requêtes

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=rm-uf6wjk5*****
&Expired=False
&Common request parameters

Exemples de réponses réussies

XML format

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

<DescribeDBInstanceAttributeResponse>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <Items>
        <VpcId>vpc-*****</VpcId>
        <CreationTime>2011-05-30T12:11:04Z</CreationTime>
        <IncrementSourceDBInstanceId>rm-uf6wjk5*****</IncrementSourceDBInstanceId>
        <MaintainTime>00:00Z-02:00Z</MaintainTime>
        <PayType>Postpaid</PayType>
        <AvailabilityValue>100.0%</AvailabilityValue>
        <EngineVersion>5.5</EngineVersion>
        <DedicatedHostGroupId>dhg-7a9*****</DedicatedHostGroupId>
        <ConnectionString>rm-uf6wjk5*****.mysql.rds.aliyuncs.com</ConnectionString>
        <SuperPermissionMode>Disabled</SuperPermissionMode>
        <InstanceNetworkType>Classic</InstanceNetworkType>
        <MasterInstanceId>rm-uf6wjk5*****</MasterInstanceId>
        <AutoUpgradeMinorVersion>Auto</AutoUpgradeMinorVersion>
        <ExpireTime>2019-03-27T16:00:00Z</ExpireTime>
        <AccountMaxQuantity>50</AccountMaxQuantity>
        <MasterZone>5454284</MasterZone>
        <GuardDBInstanceId>rm-uf64zsu*****</GuardDBInstanceId>
        <DBInstanceStorage>10</DBInstanceStorage>
        <TimeZone>Central Standard Time</TimeZone>
        <LatestKernelVersion>rds_20201031</LatestKernelVersion>
        <TipsLevel>1</TipsLevel>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <MaxConnections>60</MaxConnections>
        <DBInstanceId>rm-uf6wjk5*****</DBInstanceId>
        <TempDBInstanceId>rm-uf64zsu*****</TempDBInstanceId>
        <AdvancedFeatures>LinkedServer</AdvancedFeatures>
        <DBInstanceStorageType>local_ssd</DBInstanceStorageType>
        <DBInstanceMemory>4096</DBInstanceMemory>
        <IPType>IPv4</IPType>
        <ConsoleVersion>2</ConsoleVersion>
        <ConnectionMode>Standard</ConnectionMode>
        <Port>3306</Port>
        <LockMode>Unlock</LockMode>
        <GeneralGroupName>TestGroup</GeneralGroupName>
        <VpcCloudInstanceId>vpc-23rsxdf*****</VpcCloudInstanceId>
        <Collation>Chinese_PRC_CI_AS</Collation>
        <MaxIOPS>150</MaxIOPS>
        <Tips>Run as normal</Tips>
        <SecurityIPList>192.168.XX.XX/24</SecurityIPList>
        <SecurityIPMode>normal</SecurityIPMode>
        <DBInstanceClassType>s</DBInstanceClassType>
        <ProxyType>1</ProxyType>
        <CurrentKernelVersion>rds_20181010</CurrentKernelVersion>
        <DBInstanceDescription>Test database</DBInstanceDescription>
        <DBInstanceCPU>2</DBInstanceCPU>
        <DBInstanceNetType>Internet</DBInstanceNetType>
        <DBInstanceType>Primary</DBInstanceType>
        <LockReason>instance_expired</LockReason>
        <DBInstanceStatus>Running</DBInstanceStatus>
        <DBMaxQuantity>200</DBMaxQuantity>
        <RegionId>cn-hangzhou </RegionId>
        <ReadonlyInstanceSQLDelayedTime>30</ReadonlyInstanceSQLDelayedTime>
        <VSwitchId>vsw-*****</VSwitchId>
        <ResourceGroupId>rg-acfmy*****</ResourceGroupId>
        <Category>Basic</Category>
        <DBInstanceClass>rds.mys2.small</DBInstanceClass>
        <Engine>MySQL</Engine>
        <SlaveZones>
            <ZoneId>cn-hangzhou-a</ZoneId>
        </SlaveZones>
        <ReadOnlyDBInstanceIds>
            <DBInstanceId>rm-bp*****</DBInstanceId>
        </ReadOnlyDBInstanceIds>
        <Extra>
            <DBInstanceIds>rm-uf6wjk5*****</DBInstanceIds>
        </Extra>
        <DeletionProtection>true</DeletionProtection>
        <ServerlessConfig>
            <ScaleMin>0.5</ScaleMin>
            <ScaleMax>8</ScaleMax>
            <AutoPause>true</AutoPause>
            <SwitchForce>false</SwitchForce>
        </ServerlessConfig>
        <BabelfishConfig>
            <BabelfishEnabled>true</BabelfishEnabled>
            <MigrationMode>single-db</MigrationMode>
        </BabelfishConfig>
        <kindCode>None</kindCode>
        <InstructionSetArch>x86</InstructionSetArch>
        <DBClusterNodes>
            <NodeRegionId>cn-beijing</NodeRegionId>
            <NodeZoneId>cn-beijing-h</NodeZoneId>
            <NodeId>rn-****</NodeId>
            <NodeRole>primary</NodeRole>
            <ClassCode>mysql.n2.medium.xc</ClassCode>
        </DBClusterNodes>
    </Items>
</DescribeDBInstanceAttributeResponse>

JSON format

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

{
  "RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items" : [ {
    "VpcId" : "vpc-*****",
    "CreationTime" : "2011-05-30T12:11:04Z",
    "IncrementSourceDBInstanceId" : "rm-uf6wjk5*****",
    "MaintainTime" : "00:00Z-02:00Z",
    "PayType" : "Postpaid",
    "AvailabilityValue" : "100.0%",
    "EngineVersion" : "5.5",
    "DedicatedHostGroupId" : "dhg-7a9*****",
    "ConnectionString" : "rm-uf6wjk5*****.mysql.rds.aliyuncs.com",
    "SuperPermissionMode" : "Disabled",
    "InstanceNetworkType" : "Classic",
    "MasterInstanceId" : "rm-uf6wjk5*****",
    "AutoUpgradeMinorVersion" : "Auto",
    "ExpireTime" : "2019-03-27T16:00:00Z",
    "AccountMaxQuantity" : 50,
    "MasterZone" : "5454284",
    "GuardDBInstanceId" : "rm-uf64zsu*****",
    "DBInstanceStorage" : 10,
    "TimeZone" : "Central Standard Time",
    "LatestKernelVersion" : "rds_20201031",
    "TipsLevel" : 1,
    "ZoneId" : "cn-hangzhou-a",
    "MaxConnections" : 60,
    "DBInstanceId" : "rm-uf6wjk5*****",
    "TempDBInstanceId" : "rm-uf64zsu*****",
    "AdvancedFeatures" : "LinkedServer",
    "DBInstanceStorageType" : "local_ssd",
    "DBInstanceMemory" : 4096,
    "IPType" : "IPv4",
    "ConsoleVersion" : "2",
    "ConnectionMode" : "Standard",
    "Port" : "3306",
    "LockMode" : "Unlock",
    "GeneralGroupName" : "TestGroup",
    "VpcCloudInstanceId" : "vpc-23rsxdf*****",
    "Collation" : "Chinese_PRC_CI_AS",
    "MaxIOPS" : 150,
    "Tips" : "Run as normal",
    "SecurityIPList" : "192.168.XX.XX/24",
    "SecurityIPMode" : "normal",
    "DBInstanceClassType" : "s",
    "ProxyType" : 1,
    "CurrentKernelVersion" : "rds_20181010",
    "DBInstanceDescription": "Test database",
    "DBInstanceCPU" : "2",
    "DBInstanceNetType" : "Internet",
    "DBInstanceType" : "Primary",
    "LockReason" : "instance_expired",
    "DBInstanceStatus" : "Running",
    "DBMaxQuantity" : 200,
    "RegionId" : "cn-hangzhou ",
    "ReadonlyInstanceSQLDelayedTime" : "30",
    "VSwitchId" : "vsw-*****",
    "ResourceGroupId" : "rg-acfmy*****",
    "Category" : "Basic",
    "DBInstanceClass" : "rds.mys2.small",
    "Engine" : "MySQL",
    "SlaveZones" : [ {
      "ZoneId" : "cn-hangzhou-a"
    } ],
    "ReadOnlyDBInstanceIds" : [ {
      "DBInstanceId" : "rm-bp*****"
    } ],
    "Extra" : {
      "DBInstanceIds" : [ "rm-uf6wjk5*****" ]
    },
    "DeletionProtection" : true,
    "ServerlessConfig" : {
      "ScaleMin" : 0.5,
      "ScaleMax" : 8,
      "AutoPause" : true,
      "SwitchForce" : false
    },
    "BabelfishConfig" : {
      "BabelfishEnabled" : "true",
      "MigrationMode" : "single-db"
    },
    "kindCode" : "None",
    "InstructionSetArch" : "x86",
    "DBClusterNodes" : [ {
      "NodeRegionId" : "cn-beijing",
      "NodeZoneId" : "cn-beijing-h",
      "NodeId" : "rn-****",
      "NodeRole" : "primary",
      "ClassCode" : "mysql.n2.medium.xc"
    } ]
  } ]
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	ConnectTimeoutRetryLater	Connect timeout retry later.	Le message d'erreur indique que la connexion à l'instance a expiré. Réessayez ultérieurement.
400	DataNotExist	Data not exist.	Le message d'erreur indique qu'aucune donnée n'est disponible.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.