DescribeDBInstanceAttribute - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeDBInstanceAttribute	A operação a ser executada. Defina o valor como DescribeDBInstanceAttribute.
RegionId	String	Não	cn-hangzhou	O ID da região da instância. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
Engine	String	Não	MongoDB	O mecanismo de banco de dados da instância. Defina o valor como MongoDB.
DBInstanceId	String	Sim	dds-bp11483712c1****	O ID da instância.
ResourceGroupId	String	Não	rg-acfmyiu4ekp****	O ID do grupo de recursos. Para obter mais informações, consulte Visualizar informações básicas de um grupo de recursos. Nota Este parâmetro está disponível apenas se você usar o site da China (aliyun.com).

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	A935A8EE-A6CC-53DE-98BA-20ABAA7E632B	O ID da solicitação.
DBInstances	Array of DBInstance		Detalhes da instância.
DBInstance
CreationTime	String	2022-01-02T07:43:59Z	O horário de criação da instância. Segue o padrão ISO 8601 no formato aaaa-MM-ddTHH:mm:ssZ e é exibido em UTC.
ReplicaSets	Array of ReplicaSet		Detalhes da instância de conjunto de réplicas. Nota Retornado se a instância for do tipo conjunto de réplicas.
ReplicaSet
VSwitchId	String	vpc-bp1jk5vwkcri27qme****	O ID do vSwitch. Nota Retornado se o tipo de rede da instância for Virtual Private Cloud (VPC).
ConnectionPort	String	3717	O número da porta usada para conectar-se ao nó.
ReplicaSetRole	String	Primary	A função do nó. Valores válidos: Primary Secondary
ConnectionDomain	String	dds-bp11483712c1****.mongodb.rds.aliyuncs.com	O endpoint do nó.
VPCCloudInstanceId	String	dds-bp11483712c1****	O ID da instância. Nota Retornado se o tipo de rede da instância for VPC.
NetworkType	String	VPC	O tipo de rede da instância. Valores válidos: Classic: rede clássica VPC: VPC
VPCId	String	vpc-bp1jk5vwkcri27qme****	O ID da VPC. Nota Retornado se o tipo de rede da instância for VPC.
ReplacateId	String	bls-m****	O ID lógico da instância de réplica. Nota O ApsaraDB for MongoDB não oferece suporte a novas instâncias deste tipo. Este parâmetro aplica-se apenas a instâncias de réplica de versões anteriores.
ChargeType	String	PostPaid	O método de faturamento da instância. Valores válidos: PrePaid: assinatura PostPaid: pagamento conforme o uso
Tags	Array of Tag		Detalhes das tags da instância.
Tag
Key	String	test	A chave da tag da instância.
Value	String	api	O valor da tag da instância.
VpcAuthMode	String	Open	Indica se o acesso sem senha dentro da VPC está ativado. Valores válidos: Open: o acesso sem senha está ativado. Close: o acesso sem senha está desativado e é necessário usar uma senha para acesso. NotSupport: não há suporte para acesso sem senha.
NetworkType	String	VPC	O tipo de rede da instância. Valores válidos: Classic: rede clássica VPC: VPC
LockMode	String	Unlock	O estado de bloqueio da instância. Valores válidos: Unlock: a instância não está bloqueada. ManualLock: a instância foi bloqueada manualmente. LockByExpiration: a instância foi bloqueada automaticamente devido à expiração. LockByRestoration: a instância foi bloqueada automaticamente antes de ser revertida. LockByDiskQuota: a instância foi bloqueada automaticamente devido à capacidade de armazenamento esgotada. Released: a instância foi liberada.
EngineVersion	String	4.4	A versão do mecanismo de banco de dados da instância. Valores válidos: 5.0 4.4 4.2 4.0 3.4
MaxIOPS	Integer	1000	O IOPS máximo da instância.
VPCCloudInstanceIds	String	dds-bp11483712c1****	O ID da instância. Nota Retornado se o tipo de rede da instância for VPC.
MongosList	Array of MongosAttribute		Detalhes dos nós mongos. Nota Retornado se a instância for do tipo cluster fragmentado.
MongosAttribute
VpcCloudInstanceId	String	s-bp1d8c262a158****	O ID do nó mongos.
MaxIOPS	Integer	800	O IOPS máximo do nó mongos.
VSwitchId	String	vsw-bp1vj604nj5a9zz74****	O ID do vSwitch. Nota Retornado se o tipo de rede da instância for VPC.
NodeClass	String	dds.mongos.mid	O tipo do nó mongos.
MaxConnections	Integer	1000	O número máximo de conexões com o nó mongos.
Port	Integer	3717	O número da porta usada para conectar-se ao nó mongos.
VPCId	String	vpc-bp1n3i15v90el48nx****	O ID da VPC. Nota Retornado se o tipo de rede da instância for VPC.
ConnectSting	String	s-bp1d8c262a15****.mongodb.rds.aliyuncs.com	O endpoint do nó mongos.
NodeDescription	String	mongos1	O nome do nó mongos.
NodeId	String	s-bp1d8c262a15****	O ID do nó mongos.
Status	String	Running	O estado do nó mongos. Para obter mais informações, consulte Estados da instância.
ProtocolType	String	mongodb	O tipo de protocolo de acesso da instância. Valores válidos: mongodb: protocolo MongoDB dynamodb: protocolo DynamoDB Nota Retornado se a instância for do tipo cluster fragmentado.
DBInstanceDescription	String	testdatabase	O nome da instância.
CurrentKernelVersion	String	mongodb_20211014_3.0.38	A versão secundária do banco de dados atual na instância.
DBInstanceReleaseProtection	Boolean	false	Indica se a proteção contra liberação está ativada para a instância. Valores válidos: true: a proteção contra liberação está ativada. false: a proteção contra liberação está desativada.
ExpireTime	String	2022-02-05T16:00Z	O horário de expiração da instância por assinatura. Está no formato aaaa-MM-ddTHH:mmZ e é exibido em UTC. Nota Retornado se a instância for do tipo assinatura.
MaintainStartTime	String	18:00Z	O horário de início da janela de manutenção. Está no formato HH:mmZ e é exibido em UTC.
DBInstanceType	String	replicate	A arquitetura da instância. Valores válidos: replicate: instância de conjunto de réplicas sharding: instância de cluster fragmentado
LastDowngradeTime	String	2022-01-08	A data da última operação de downgrade.
ShardList	Array of ShardAttribute		Detalhes dos nós shard. Nota Retornado se a instância for do tipo cluster fragmentado.
ShardAttribute
MaxIOPS	Integer	8000	O IOPS máximo do nó shard.
ConnectString	String	d-bp1af0680a9c6d3**.mongodb.rds.aliyuncs.com:**	O endpoint do nó shard.
NodeClass	String	dds.shard.mid	O tipo do nó shard.
MaxConnections	Integer	8000	O número máximo de conexões com o nó shard.
Port	Integer	3717	O número da porta usada para conectar-se ao nó shard.
NodeDescription	String	testshard	O nome do nó shard.
NodeId	String	d-bp16e09d9c5d****	O ID do nó shard.
NodeStorage	Integer	10	A capacidade de armazenamento do nó shard.
ReadonlyReplicas	Integer	0	O número de nós somente leitura no nó shard. Valores válidos: 0 a 5. O valor deve ser um número inteiro.
Status	String	Running	O estado do nó shard. Para obter mais informações, consulte Estados da instância.
MaintainEndTime	String	03:00Z	O horário de término da janela de manutenção. Está no formato HH:mmZ e é exibido em UTC.
DBInstanceStatus	String	Running	O estado da instância. Para obter mais informações, consulte Estados da instância.
VPCId	String	vpc-bp1n3i15v90el48nx****	O ID da VPC. Nota Retornado se o tipo de rede da instância for VPC.
RegionId	String	cn-hangzhou	O ID da região da instância.
DBInstanceStorage	Integer	10	A capacidade de armazenamento da instância.
ReplicaSetName	String	mgset-10ace****	O nome da instância de conjunto de réplicas. Nota Retornado se a instância for do tipo conjunto de réplicas.
VSwitchId	String	vsw-bp1oo2a7isyrb8igf****	O ID do vSwitch. Nota Retornado se o tipo de rede da instância for VPC.
StorageEngine	String	WiredTiger	O mecanismo de armazenamento da instância.
ConfigserverList	Array of ConfigserverAttribute		Detalhes dos nós Configserver. Nota Retornado se a instância for do tipo cluster fragmentado.
ConfigserverAttribute
MaxIOPS	Integer	1000	O IOPS máximo do nó Configserver.
ConnectString	String	dds-bp18b0934e7053e4-cs****.mongodb.rds.aliyuncs.com	O endpoint do nó Configserver.
NodeClass	String	dds.cs.mid	O tipo do nó Configserver.
MaxConnections	Integer	1000	O número máximo de conexões com o nó Configserver.
Port	Integer	3717	O número da porta usada para conectar-se ao nó Configserver.
NodeDescription	String	testConfigserver	O nome do nó Configserver.
NodeId	String	dds-bp11483712c1****-cs	O ID do nó Configserver.
NodeStorage	Integer	20	A capacidade de armazenamento do nó Configserver.
Status	String	Running	O estado do nó Configserver. Para obter mais informações, consulte Estados da instância.
ResourceGroupId	String	rg-acfmyiu4ekp****	O ID do grupo de recursos. Nota Retornado apenas se você usar o site da China (aliyun.com).
ZoneId	String	cn-hangzhou-b	O ID da zona da instância.
MaxConnections	Integer	500	O número máximo de conexões com a instância.
DBInstanceId	String	dds-bp11483712c1****	O ID da instância.
DBInstanceClass	String	dds.mongo.mid	O tipo da instância.
Engine	String	MongoDB	O mecanismo de banco de dados da instância.
ReadonlyReplicas	String	1	O número de nós somente leitura na instância.
ReplicationFactor	String	3	O número de nós na instância. Nota Retornado se a instância for do tipo conjunto de réplicas.
KindCode	String	1	O código de tipo da instância. Valores válidos: 0: máquina física 1: instância Elastic Compute Service (ECS) 2: cluster Docker 18: cluster Kubernetes
CapacityUnit	String	100	O throughput de E/S consumido pela instância.
SecondaryZoneId	String	cn-hangzhou-i	O ID da zona secundária 1 da instância. Valores válidos: cn-hangzhou-g: Hangzhou Zona G cn-hangzhou-h: Hangzhou Zona H cn-hangzhou-i: Hangzhou Zona I cn-hongkong-b: Hong Kong Zona B cn-hongkong-c: Hong Kong Zona C cn-hongkong-d: Hong Kong Zona D cn-wulanchabu-a: Ulanqab Zona A cn-wulanchabu-b: Ulanqab Zona B cn-wulanchabu-c: Ulanqab Zona C ap-southeast-1a: Singapura Zona A ap-southeast-1b: Singapura Zona B ap-southeast-1c: Singapura Zona C ap-southeast-5a: Jacarta Zona A ap-southeast-5b: Jacarta Zona B ap-southeast-5c: Jacarta Zona C eu-central-1a: Frankfurt Zona A eu-central-1b: Frankfurt Zona B eu-central-1c: Frankfurt Zona C Nota Retornado se a instância for do tipo conjunto de réplicas ou cluster fragmentado, executar o MongoDB 4.4 ou 5.0 e utilizar implantação multizona. Retornado apenas se você usar o site da China (aliyun.com).
HiddenZoneId	String	cn-hangzhou-h	O ID da zona secundária 2 da instância. Valores válidos: cn-hangzhou-g: Hangzhou Zona G cn-hangzhou-h: Hangzhou Zona H cn-hangzhou-i: Hangzhou Zona I cn-hongkong-b: Hong Kong Zona B cn-hongkong-c: Hong Kong Zona C cn-hongkong-d: Hong Kong Zona D cn-wulanchabu-a: Ulanqab Zona A cn-wulanchabu-b: Ulanqab Zona B cn-wulanchabu-c: Ulanqab Zona C ap-southeast-1a: Singapura Zona A ap-southeast-1b: Singapura Zona B ap-southeast-1c: Singapura Zona C ap-southeast-5a: Jacarta Zona A ap-southeast-5b: Jacarta Zona B ap-southeast-5c: Jacarta Zona C eu-central-1a: Frankfurt Zona A eu-central-1b: Frankfurt Zona B eu-central-1c: Frankfurt Zona C Nota Retornado se a instância for do tipo conjunto de réplicas ou cluster fragmentado, executar o MongoDB 4.4 ou 5.0 e utilizar implantação multizona. Retornado apenas se você usar o site da China (aliyun.com).

Exemplos

Solicitações de exemplo

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

Respostas de sucesso de exemplo

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 erro

Para obter uma lista de códigos de erro, visite o API Error Center.