DescribeDBInstanceAttribute - - 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 des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeDBInstanceAttribute	Opération à effectuer. Définissez la valeur sur DescribeDBInstanceAttribute.
RegionId	String	Non	cn-hangzhou	ID de région de l'instance. Appelez l'opération DescribeRegions pour obtenir la liste des régions les plus récentes.
Engine	String	Non	MongoDB	Moteur de base de données de l'instance. La valeur est définie sur MongoDB.
DBInstanceId	String	Oui	dds-bp11483712c1****	ID de l'instance.
ResourceGroupId	String	Non	rg-acfmyiu4ekp****	ID du groupe de ressources. Pour plus d'informations, consultez Afficher les informations de base d'un groupe de ressources. Remarque Ce paramètre est disponible uniquement si vous utilisez le site Chine (aliyun.com).

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	A935A8EE-A6CC-53DE-98BA-20ABAA7E632B	ID de la requête.
DBInstances	Array of DBInstance		Détails de l'instance.
DBInstance
CreationTime	String	2022-01-02T07:43:59Z	Date et heure de création de l'instance, au format ISO 8601 : yyyy-MM-ddTHH:mm:ssZ (UTC).
ReplicaSets	Array of ReplicaSet		Détails de l'instance de jeu de réplicas. Remarque Ce paramètre est renvoyé si l'instance est une instance de jeu de réplicas.
ReplicaSet
VSwitchId	String	vpc-bp1jk5vwkcri27qme****	ID du vSwitch. Remarque Ce paramètre est renvoyé si le type de réseau de l'instance est Virtual Private Cloud (VPC).
ConnectionPort	String	3717	Numéro de port utilisé pour se connecter au nœud.
ReplicaSetRole	String	Primary	Rôle du nœud. Valeurs possibles : Primary Secondary
ConnectionDomain	String	dds-bp11483712c1****.mongodb.rds.aliyuncs.com	Endpoint du nœud.
VPCCloudInstanceId	String	dds-bp11483712c1****	ID de l'instance. Remarque Ce paramètre est renvoyé si le type de réseau de l'instance est VPC.
NetworkType	String	VPC	Type de réseau de l'instance. Valeurs possibles : Classic : réseau classique VPC : VPC
VPCId	String	vpc-bp1jk5vwkcri27qme****	ID du VPC. Remarque Ce paramètre est renvoyé si le type de réseau de l'instance est VPC.
ReplacateId	String	bls-m****	ID logique de l'instance de réplica. Remarque ApsaraDB for MongoDB ne prend plus en charge la création de nouvelles instances de ce type. Ce paramètre s'applique uniquement aux anciennes instances de réplica.
ChargeType	String	PostPaid	Mode de facturation de l'instance. Valeurs possibles : PrePaid : abonnement PostPaid : paiement à l'utilisation
Tags	Array of Tag		Détails des tags de l'instance.
Tag
Key	String	test	Clé du tag de l'instance.
Value	String	api	Valeur du tag de l'instance.
VpcAuthMode	String	Open	Indique si l'accès sans mot de passe au sein du VPC est activé. Valeurs possibles : Open : L'accès sans mot de passe est activé. Close : L'accès sans mot de passe est désactivé ; un mot de passe est requis. NotSupport : L'accès sans mot de passe n'est pas pris en charge.
NetworkType	String	VPC	Type de réseau de l'instance. Valeurs possibles : Classic : réseau classique VPC : VPC
LockMode	String	Unlock	État de verrouillage de l'instance. Valeurs possibles : 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 avant sa restauration. LockByDiskQuota : L'instance est automatiquement verrouillée en raison de l'épuisement de l'espace de stockage. Released : L'instance a été libérée.
EngineVersion	String	4.4	Version du moteur de base de données de l'instance. Valeurs possibles : 5.0 4.4 4.2 4.0 3.4
MaxIOPS	Integer	1000	Nombre maximal d'IOPS de l'instance.
VPCCloudInstanceIds	String	dds-bp11483712c1****	ID de l'instance. Remarque Ce paramètre est renvoyé si le type de réseau de l'instance est VPC.
MongosList	Array of MongosAttribute		Détails des nœuds mongos. Remarque Ce paramètre est renvoyé si l'instance est un cluster fragmenté.
MongosAttribute
VpcCloudInstanceId	String	s-bp1d8c262a158****	ID du nœud mongos.
MaxIOPS	Integer	800	Nombre maximal d'IOPS du nœud mongos.
VSwitchId	String	vsw-bp1vj604nj5a9zz74****	ID du vSwitch. Remarque Ce paramètre est renvoyé si le type de réseau de l'instance est VPC.
NodeClass	String	dds.mongos.mid	Type du nœud mongos.
MaxConnections	Integer	1000	Nombre maximal de connexions au nœud mongos.
Port	Integer	3717	Numéro de port utilisé pour se connecter au nœud mongos.
VPCId	String	vpc-bp1n3i15v90el48nx****	ID du VPC. Remarque Ce paramètre est renvoyé si le type de réseau de l'instance est VPC.
ConnectSting	String	s-bp1d8c262a15****.mongodb.rds.aliyuncs.com	Endpoint du nœud mongos.
NodeDescription	String	mongos1	Nom du nœud mongos.
NodeId	String	s-bp1d8c262a15****	ID du nœud mongos.
Status	String	Running	État du nœud mongos. Pour plus d'informations, consultez États des instances.
ProtocolType	String	mongodb	Type de protocole d'accès de l'instance. Valeurs possibles : mongodb : protocole MongoDB dynamodb : protocole DynamoDB Remarque Ce paramètre est renvoyé si l'instance est un cluster fragmenté.
DBInstanceDescription	String	testdatabase	Nom de l'instance.
CurrentKernelVersion	String	mongodb_20211014_3.0.38	Version mineure actuelle de la base de données de l'instance.
DBInstanceReleaseProtection	Boolean	false	Indique si la protection contre la suppression est activée pour l'instance. Valeurs possibles : true : La protection contre la suppression est activée. false : La protection contre la suppression est désactivée.
ExpireTime	String	2022-02-05T16:00Z	Date et heure d'expiration de l'instance d'abonnement, au format yyyy-MM-ddTHH:mmZ (UTC). Remarque Ce paramètre est renvoyé si l'instance est une instance d'abonnement.
MaintainStartTime	String	18:00Z	Heure de début de la fenêtre de maintenance, au format HH:mmZ (UTC).
DBInstanceType	String	replicate	Architecture de l'instance. Valeurs possibles : replicate : instance de jeu de réplicas sharding : cluster fragmenté
LastDowngradeTime	String	2022-01-08	Date de la dernière opération de rétrogradation.
ShardList	Array of ShardAttribute		Détails des nœuds shard. Remarque Ce paramètre est renvoyé si l'instance est un cluster fragmenté.
ShardAttribute
MaxIOPS	Integer	8000	Nombre maximal d'IOPS du nœud shard.
ConnectString	String	d-bp1af0680a9c6d3**.mongodb.rds.aliyuncs.com:**	Endpoint du nœud shard.
NodeClass	String	dds.shard.mid	Type du nœud shard.
MaxConnections	Integer	8000	Nombre maximal de connexions au nœud shard.
Port	Integer	3717	Numéro de port utilisé pour se connecter au nœud shard.
NodeDescription	String	testshard	Nom du nœud shard.
NodeId	String	d-bp16e09d9c5d****	ID du nœud shard.
NodeStorage	Integer	10	Capacité de stockage du nœud shard.
ReadonlyReplicas	Integer	0	Nombre de nœuds en lecture seule dans le nœud shard. Valeurs possibles : 0 à 5 (entier).
Status	String	Running	État du nœud shard. Pour plus d'informations, consultez États des instances.
MaintainEndTime	String	03:00Z	Heure de fin de la fenêtre de maintenance, au format HH:mmZ (UTC).
DBInstanceStatus	String	Running	État de l'instance. Pour plus d'informations, consultez États des instances.
VPCId	String	vpc-bp1n3i15v90el48nx****	ID du VPC. Remarque Ce paramètre est renvoyé si le type de réseau de l'instance est VPC.
RegionId	String	cn-hangzhou	ID de région de l'instance.
DBInstanceStorage	Integer	10	Capacité de stockage de l'instance.
ReplicaSetName	String	mgset-10ace****	Nom de l'instance de jeu de réplicas. Remarque Ce paramètre est renvoyé si l'instance est une instance de jeu de réplicas.
VSwitchId	String	vsw-bp1oo2a7isyrb8igf****	ID du vSwitch. Remarque Ce paramètre est renvoyé si le type de réseau de l'instance est VPC.
StorageEngine	String	WiredTiger	Moteur de stockage de l'instance.
ConfigserverList	Array of ConfigserverAttribute		Détails des nœuds Configserver. Remarque Ce paramètre est renvoyé si l'instance est un cluster fragmenté.
ConfigserverAttribute
MaxIOPS	Integer	1000	Nombre maximal d'IOPS du nœud Configserver.
ConnectString	String	dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com	Endpoint du nœud Configserver.
NodeClass	String	dds.cs.mid	Type du nœud Configserver.
MaxConnections	Integer	1000	Nombre maximal de connexions au nœud Configserver.
Port	Integer	3717	Numéro de port utilisé pour se connecter au nœud Configserver.
NodeDescription	String	testConfigserver	Nom du nœud Configserver.
NodeId	String	dds-bp11483712c1****-cs	ID du nœud Configserver.
NodeStorage	Integer	20	Capacité de stockage du nœud Configserver.
Status	String	Running	État du nœud Configserver. Pour plus d'informations, consultez États des instances.
ResourceGroupId	String	rg-acfmyiu4ekp****	ID du groupe de ressources. Remarque Ce paramètre est renvoyé uniquement si vous utilisez le site Chine (aliyun.com).
ZoneId	String	cn-hangzhou-b	ID de zone de l'instance.
MaxConnections	Integer	500	Nombre maximal de connexions à l'instance.
DBInstanceId	String	dds-bp11483712c1****	ID de l'instance.
DBInstanceClass	String	dds.mongo.mid	Type d'instance.
Engine	String	MongoDB	Moteur de base de données de l'instance.
ReadonlyReplicas	String	1	Nombre de nœuds en lecture seule dans l'instance.
ReplicationFactor	String	3	Nombre de nœuds dans l'instance. Remarque Ce paramètre est renvoyé si l'instance est une instance de jeu de réplicas.
KindCode	String	1	Code de type de l'instance. Valeurs possibles : 0 : machine physique 1 : instance Elastic Compute Service (ECS) 2 : cluster docker 18 : cluster Kubernetes
CapacityUnit	String	100	Débit d'E/S consommé par l'instance.
SecondaryZoneId	String	cn-hangzhou-i	ID de la zone secondaire 1 de l'instance. Valeurs possibles : cn-hangzhou-g : Hangzhou Zone G cn-hangzhou-h : Hangzhou Zone H cn-hangzhou-i : Hangzhou Zone I cn-hongkong-b : Hongkong Zone B cn-hongkong-c : Hongkong Zone C cn-hongkong-d : Hongkong Zone D cn-wulanchabu-a : Ulanqab Zone A cn-wulanchabu-b : Ulanqab Zone B cn-wulanchabu-c : Ulanqab Zone C ap-southeast-1a : Singapore Zone A ap-southeast-1b : Singapore Zone B ap-southeast-1c : Singapore Zone C ap-southeast-5a : Jakarta Zone A ap-southeast-5b : Jakarta Zone B ap-southeast-5c : Jakarta Zone C eu-central-1a : Frankfurt Zone A eu-central-1b : Frankfurt Zone B eu-central-1c : Frankfurt Zone C Remarque Ce paramètre est renvoyé si l'instance est une instance de jeu de réplicas ou un cluster fragmenté exécutant MongoDB 4.4 ou 5.0 avec un déploiement multi-zone. Ce paramètre est renvoyé uniquement si vous utilisez le site Chine (aliyun.com).
HiddenZoneId	String	cn-hangzhou-h	ID de la zone secondaire 2 de l'instance. Valeurs possibles : cn-hangzhou-g : Hangzhou Zone G cn-hangzhou-h : Hangzhou Zone H cn-hangzhou-i : Hangzhou Zone I cn-hongkong-b : Hongkong Zone B cn-hongkong-c : Hongkong Zone C cn-hongkong-d : Hongkong Zone D cn-wulanchabu-a : Ulanqab Zone A cn-wulanchabu-b : Ulanqab Zone B cn-wulanchabu-c : Ulanqab Zone C ap-southeast-1a : Singapore Zone A ap-southeast-1b : Singapore Zone B ap-southeast-1c : Singapore Zone C ap-southeast-5a : Jakarta Zone A ap-southeast-5b : Jakarta Zone B ap-southeast-5c : Jakarta Zone C eu-central-1a : Frankfurt Zone A eu-central-1b : Frankfurt Zone B eu-central-1c : Frankfurt Zone C Remarque Ce paramètre est renvoyé si l'instance est une instance de jeu de réplicas ou un cluster fragmenté exécutant MongoDB 4.4 ou 5.0 avec un déploiement multi-zone. Ce paramètre est renvoyé uniquement si vous utilisez le site Chine (aliyun.com).

Exemples

Exemples de requêtes

http(s)://mongodb.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=dds-bp11483712c1****
&<Common request parameters>

Exemples de réponses réussies

Format XML

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

<DescribeDBInstanceAttributeResponse>
    <RequestId>A935A8EE-A6CC-53DE-98BA-20ABAA7E632B</RequestId>
    <DBInstances>
        <CreationTime>2022-01-02T07:43:59Z</CreationTime>
        <ReplicaSets>
            <VSwitchId>vpc-bp1jk5vwkcri27qme****</VSwitchId>
            <ConnectionPort>3717</ConnectionPort>
            <ReplicaSetRole>Primary</ReplicaSetRole>
            <ConnectionDomain>dds-bp11483712c1****.mongodb.rds.aliyuncs.com</ConnectionDomain>
            <VPCCloudInstanceId>dds-bp11483712c1****</VPCCloudInstanceId>
            <NetworkType>VPC</NetworkType>
            <VPCId>vpc-bp1jk5vwkcri27qme****</VPCId>
        </ReplicaSets>
        <ChargeType>PostPaid</ChargeType>
        <Tags>
            <Key>test</Key>
            <Value>api</Value>
        </Tags>
        <VpcAuthMode>Open</VpcAuthMode>
        <NetworkType>VPC</NetworkType>
        <LockMode>Unlock</LockMode>
        <EngineVersion>4.4</EngineVersion>
        <MaxIOPS>1000</MaxIOPS>
        <ProtocolType>mongodb</ProtocolType>
        <DBInstanceDescription>testdatabase</DBInstanceDescription>
        <CurrentKernelVersion>mongodb_20211014_3.0.38</CurrentKernelVersion>
        <DBInstanceReleaseProtection>false</DBInstanceReleaseProtection>
        <MaintainStartTime>18:00Z</MaintainStartTime>
        <DBInstanceType>replicate</DBInstanceType>
        <LastDowngradeTime>2022-01-08</LastDowngradeTime>
        <MaintainEndTime>03:00Z</MaintainEndTime>
        <DBInstanceStatus>Running</DBInstanceStatus>
        <VPCId>vpc-bp1n3i15v90el48nx****</VPCId>
        <RegionId>cn-hangzhou</RegionId>
        <DBInstanceStorage>10</DBInstanceStorage>
        <ReplicaSetName>mgset-10ace****</ReplicaSetName>
        <VSwitchId>vsw-bp1oo2a7isyrb8igf****</VSwitchId>
        <StorageEngine>WiredTiger</StorageEngine>
        <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
        <ZoneId>cn-hangzhou-b</ZoneId>
        <MaxConnections>500</MaxConnections>
        <DBInstanceId>dds-bp11483712c1****</DBInstanceId>
        <DBInstanceClass>dds.mongo.mid</DBInstanceClass>
        <Engine>MongoDB</Engine>
        <ReadonlyReplicas>1</ReadonlyReplicas>
        <ReplicationFactor>3</ReplicationFactor>
        <KindCode>1</KindCode>
        <CapacityUnit>100</CapacityUnit>
    </DBInstances>
</DescribeDBInstanceAttributeResponse>

Format JSON

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

{
  "RequestId" : "A935A8EE-A6CC-53DE-98BA-20ABAA7E632B",
  "DBInstances" : {
    "CreationTime" : "2022-01-02T07:43:59Z",
    "ReplicaSets" : {
      "VSwitchId" : "vpc-bp1jk5vwkcri27qme****",
      "ConnectionPort" : 3717,
      "ReplicaSetRole" : "Primary",
      "ConnectionDomain" : "dds-bp11483712c1****.mongodb.rds.aliyuncs.com",
      "VPCCloudInstanceId" : "dds-bp11483712c1****",
      "NetworkType" : "VPC",
      "VPCId" : "vpc-bp1jk5vwkcri27qme****"
    },
    "ChargeType" : "PostPaid",
    "Tags" : {
      "Key" : "test",
      "Value" : "api"
    },
    "VpcAuthMode" : "Open",
    "NetworkType" : "VPC",
    "LockMode" : "Unlock",
    "EngineVersion" : 4.4,
    "MaxIOPS" : 1000,
    "ProtocolType" : "mongodb",
    "DBInstanceDescription": "testdatabase",
    "CurrentKernelVersion" : "mongodb_20211014_3.0.38",
    "DBInstanceReleaseProtection" : false,
    "MaintainStartTime" : "18:00Z",
    "DBInstanceType" : "replicate",
    "LastDowngradeTime" : "2022-01-08",
    "MaintainEndTime" : "03:00Z",
    "DBInstanceStatus" : "Running",
    "VPCId" : "vpc-bp1n3i15v90el48nx****",
    "RegionId" : "cn-hangzhou",
    "DBInstanceStorage" : 10,
    "ReplicaSetName" : "mgset-10ace****",
    "VSwitchId" : "vsw-bp1oo2a7isyrb8igf****",
    "StorageEngine" : "WiredTiger",
    "ResourceGroupId" : "rg-acfmyiu4ekp****",
    "ZoneId" : "cn-hangzhou-b",
    "MaxConnections" : 500,
    "DBInstanceId" : "dds-bp11483712c1****",
    "DBInstanceClass" : "dds.mongo.mid",
    "Engine" : "MongoDB",
    "ReadonlyReplicas" : 1,
    "ReplicationFactor" : 3,
    "KindCode" : 1,
    "CapacityUnit" : 100
  }
}

Codes d'erreur

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