DescribeDBInstanceAttribute - - Centro de documentación de Alibaba Cloud

Consulta los detalles de una instancia de ApsaraDB for MongoDB.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, se recomienda llamar a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDKs.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeDBInstanceAttribute	La operación que desea realizar. Establezca el valor en DescribeDBInstanceAttribute.
RegionId	String	No	cn-hangzhou	El ID de región de la instancia. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
Engine	String	No	MongoDB	El motor de base de datos de la instancia. El valor se establece en MongoDB.
DBInstanceId	String	Sí	dds-bp11483712c1****	El ID de la instancia.
ResourceGroupId	String	No	rg-acfmyiu4ekp****	El ID del resource group. Para obtener más información, consulte Ver información básica de un resource group. Nota Este parámetro solo está disponible si utiliza el sitio de China (aliyun.com).

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	A935A8EE-A6CC-53DE-98BA-20ABAA7E632B	El ID de la solicitud.
DBInstances	Array of DBInstance		Detalles de la instancia.
DBInstance
CreationTime	String	2022-01-02T07:43:59Z	La hora en que se creó la instancia. La hora sigue el estándar ISO 8601 con el formato aaaa-MM-ddTHH:mm:ssZ. La hora se muestra en UTC.
ReplicaSets	Array of ReplicaSet		Detalles de la instancia de conjunto de réplicas. Nota Este parámetro se devuelve si la instancia es una instancia de conjunto de réplicas.
ReplicaSet
VSwitchId	String	vpc-bp1jk5vwkcri27qme****	El ID del vSwitch. Nota Este parámetro se devuelve si el tipo de red de la instancia es Virtual Private Cloud (VPC).
ConnectionPort	String	3717	El número de puerto que se utiliza para conectarse al nodo.
ReplicaSetRole	String	Primary	El rol del nodo. Valores válidos: Primary Secondary
ConnectionDomain	String	dds-bp11483712c1****.mongodb.rds.aliyuncs.com	El endpoint del nodo.
VPCCloudInstanceId	String	dds-bp11483712c1****	El ID de la instancia. Nota Este parámetro se devuelve si el tipo de red de la instancia es VPC.
NetworkType	String	VPC	El tipo de red de la instancia. Valores válidos: Classic: red clásica VPC: VPC
VPCId	String	vpc-bp1jk5vwkcri27qme****	El ID de la VPC. Nota Este parámetro se devuelve si el tipo de red de la instancia es VPC.
ReplacateId	String	bls-m****	El ID lógico de la instancia de réplica. Nota ApsaraDB for MongoDB no admite nuevas instancias de este tipo. Este parámetro solo aplica a instancias de réplica de versiones anteriores.
ChargeType	String	PostPaid	El método de facturación de la instancia. Valores válidos: PrePaid: suscripción PostPaid: pay-as-you-go
Tags	Array of Tag		Detalles de las etiquetas de la instancia.
Tag
Key	String	test	La clave de etiqueta de la instancia.
Value	String	api	El valor de etiqueta de la instancia.
VpcAuthMode	String	Open	Indica si el acceso sin contraseña dentro de la VPC está habilitado. Valores válidos: Open: El acceso sin contraseña está habilitado. Close: El acceso sin contraseña está deshabilitado y debe usar una contraseña para acceder. NotSupport: No se admite el acceso sin contraseña.
NetworkType	String	VPC	El tipo de red de la instancia. Valores válidos: Classic: red clásica VPC: VPC
LockMode	String	Unlock	El estado de bloqueo de la instancia. Valores válidos: Unlock: La instancia no está bloqueada. ManualLock: La instancia está bloqueada manualmente. LockByExpiration: La instancia se bloquea automáticamente debido a la caducidad de la instancia. LockByRestoration: La instancia se bloquea automáticamente antes de revertirse. LockByDiskQuota: La instancia se bloquea automáticamente debido a que se agotó la capacidad de almacenamiento. Released: La instancia ha sido liberada.
EngineVersion	String	4.4	La versión del motor de base de datos de la instancia. Valores válidos: 5.0 4.4 4.2 4.0 3.4
MaxIOPS	Integer	1000	El máximo de IOPS de la instancia.
VPCCloudInstanceIds	String	dds-bp11483712c1****	El ID de la instancia. Nota Este parámetro se devuelve si el tipo de red de la instancia es VPC.
MongosList	Array of MongosAttribute		Detalles de los nodos mongos. Nota Este parámetro se devuelve si la instancia es una instancia de clúster fragmentado.
MongosAttribute
VpcCloudInstanceId	String	s-bp1d8c262a158****	El ID del nodo mongos.
MaxIOPS	Integer	800	El máximo de IOPS del nodo mongos.
VSwitchId	String	vsw-bp1vj604nj5a9zz74****	El ID del vSwitch. Nota Este parámetro se devuelve si el tipo de red de la instancia es VPC.
NodeClass	String	dds.mongos.mid	El tipo del nodo mongos.
MaxConnections	Integer	1000	El número máximo de conexiones al nodo mongos.
Port	Integer	3717	El número de puerto que se utiliza para conectarse al nodo mongos.
VPCId	String	vpc-bp1n3i15v90el48nx****	El ID de la VPC. Nota Este parámetro se devuelve si el tipo de red de la instancia es VPC.
ConnectSting	String	s-bp1d8c262a15****.mongodb.rds.aliyuncs.com	El endpoint del nodo mongos.
NodeDescription	String	mongos1	El nombre del nodo mongos.
NodeId	String	s-bp1d8c262a15****	El ID del nodo mongos.
Status	String	Running	El estado del nodo mongos. Para obtener más información, consulte Estados de instancia.
ProtocolType	String	mongodb	El tipo de protocolo de acceso de la instancia. Valores válidos: mongodb: el protocolo MongoDB dynamodb: el protocolo DynamoDB Nota Este parámetro se devuelve si la instancia es una instancia de clúster fragmentado.
DBInstanceDescription	String	testdatabase	El nombre de la instancia.
CurrentKernelVersion	String	mongodb_20211014_3.0.38	La versión menor de la base de datos actual en la instancia.
DBInstanceReleaseProtection	Boolean	false	Indica si la protección contra liberación está habilitada para la instancia. Valores válidos: true: La protección contra liberación está habilitada. false: La protección contra liberación está deshabilitada.
ExpireTime	String	2022-02-05T16:00Z	La hora en que caduca la instancia de suscripción. La hora tiene el formato aaaa-MM-ddTHH:mmZ. La hora se muestra en UTC. Nota Este parámetro se devuelve si la instancia es una instancia de suscripción.
MaintainStartTime	String	18:00Z	La hora de inicio de la ventana de mantenimiento. La hora tiene el formato HH:mmZ. La hora se muestra en UTC.
DBInstanceType	String	replicate	La arquitectura de la instancia. Valores válidos: replicate: instancia de conjunto de réplicas sharding: instancia de clúster fragmentado
LastDowngradeTime	String	2022-01-08	La fecha en que se realizó la última operación de reducción de categoría.
ShardList	Array of ShardAttribute		Detalles de los nodos shard. Nota Este parámetro se devuelve si la instancia es una instancia de clúster fragmentado.
ShardAttribute
MaxIOPS	Integer	8000	El máximo de IOPS del nodo shard.
ConnectString	String	d-bp1af0680a9c6d3**.mongodb.rds.aliyuncs.com:**	El endpoint del nodo shard.
NodeClass	String	dds.shard.mid	El tipo del nodo shard.
MaxConnections	Integer	8000	El número máximo de conexiones al nodo shard.
Port	Integer	3717	El número de puerto que se utiliza para conectarse al nodo shard.
NodeDescription	String	testshard	El nombre del nodo shard.
NodeId	String	d-bp16e09d9c5d****	El ID del nodo shard.
NodeStorage	Integer	10	La capacidad de almacenamiento del nodo shard.
ReadonlyReplicas	Integer	0	El número de nodos de solo lectura en el nodo shard. Valores válidos: 0 a 5. El valor debe ser un número entero.
Status	String	Running	El estado del nodo shard. Para obtener más información, consulte Estados de instancia.
MaintainEndTime	String	03:00Z	La hora de finalización de la ventana de mantenimiento. La hora tiene el formato HH:mmZ. La hora se muestra en UTC.
DBInstanceStatus	String	Running	El estado de la instancia. Para obtener más información, consulte Estados de instancia.
VPCId	String	vpc-bp1n3i15v90el48nx****	El ID de la VPC. Nota Este parámetro se devuelve si el tipo de red de la instancia es VPC.
RegionId	String	cn-hangzhou	El ID de región de la instancia.
DBInstanceStorage	Integer	10	La capacidad de almacenamiento de la instancia.
ReplicaSetName	String	mgset-10ace****	El nombre de la instancia de conjunto de réplicas. Nota Este parámetro se devuelve si la instancia es una instancia de conjunto de réplicas.
VSwitchId	String	vsw-bp1oo2a7isyrb8igf****	El ID del vSwitch. Nota Este parámetro se devuelve si el tipo de red de la instancia es VPC.
StorageEngine	String	WiredTiger	El motor de almacenamiento de la instancia.
ConfigserverList	Array of ConfigserverAttribute		Detalles de los nodos Configserver. Nota Este parámetro se devuelve si la instancia es una instancia de clúster fragmentado.
ConfigserverAttribute
MaxIOPS	Integer	1000	El máximo de IOPS del nodo Configserver.
ConnectString	String	dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com	El endpoint del nodo Configserver.
NodeClass	String	dds.cs.mid	El tipo del nodo Configserver.
MaxConnections	Integer	1000	El número máximo de conexiones al nodo Configserver.
Port	Integer	3717	El número de puerto que se utiliza para conectarse al nodo Configserver.
NodeDescription	String	testConfigserver	El nombre del nodo Configserver.
NodeId	String	dds-bp11483712c1****-cs	El ID del nodo Configserver.
NodeStorage	Integer	20	La capacidad de almacenamiento del nodo Configserver.
Status	String	Running	El estado del nodo Configserver. Para obtener más información, consulte Estados de instancia.
ResourceGroupId	String	rg-acfmyiu4ekp****	El ID del resource group. Nota Este parámetro solo se devuelve si utiliza el sitio de China (aliyun.com).
ZoneId	String	cn-hangzhou-b	El ID de zona de la instancia.
MaxConnections	Integer	500	El número máximo de conexiones a la instancia.
DBInstanceId	String	dds-bp11483712c1****	El ID de la instancia.
DBInstanceClass	String	dds.mongo.mid	El tipo de instancia.
Engine	String	MongoDB	El motor de base de datos de la instancia.
ReadonlyReplicas	String	1	El número de nodos de solo lectura en la instancia.
ReplicationFactor	String	3	El número de nodos en la instancia. Nota Este parámetro se devuelve si la instancia es una instancia de conjunto de réplicas.
KindCode	String	1	El código de tipo de la instancia. Valores válidos: 0: máquina física 1: instancia de Elastic Compute Service (ECS) 2: clúster de docker 18: clúster de Kubernetes
CapacityUnit	String	100	El throughput de E/S consumido por la instancia.
SecondaryZoneId	String	cn-hangzhou-i	El ID de la zona secundaria 1 de la instancia. Valores válidos: 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 Nota Este parámetro se devuelve si la instancia es una instancia de conjunto de réplicas o de clúster fragmentado que ejecuta MongoDB 4.4 o 5.0 y utiliza despliegue multizona. Este parámetro solo se devuelve si utiliza el sitio de China (aliyun.com).
HiddenZoneId	String	cn-hangzhou-h	El ID de la zona secundaria 2 de la instancia. Valores válidos: 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 Nota Este parámetro se devuelve si la instancia es una instancia de conjunto de réplicas o de clúster fragmentado que ejecuta MongoDB 4.4 o 5.0 y utiliza despliegue multizona. Este parámetro solo se devuelve si utiliza el sitio de China (aliyun.com).

Ejemplos

Solicitudes de ejemplo

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

Respuestas exitosas de ejemplo

Formato 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>

Formato 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
  }
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.