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

Consulta os atributos de uma instância PolarDB-X, incluindo status, método de faturamento, configuração de nós, definições de rede e janela de manutenção.

Depuração

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

Parâmetros da 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	Sim	cn-hangzhou	O ID da região da instância.
DBInstanceName	String	Sim	pxc-****	O nome da instância.
ResourceGroupId	String	Não	rg-aekzaxhezhs5***	O ID do grupo de recursos.

Elementos da resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	9B2F3840-5C98-475C-B269-2D5C3A31797C	O ID da solicitação.
DBInstance	Object	—	Os detalhes da instância.

DBInstance

Parâmetro	Tipo	Exemplo	Descrição
Type	String	ReadWrite	A função da instância. Valores válidos: ReadWrite (instância primária), ReadOnly (instância somente leitura).
Status	String	Running	O status da instância. Para mais informações, consulte Estados da instância.
RightsSeparationStatus	String	disabled	O status da separação de três funções. Valores válidos: disabled (desativado), enabled (ativado), processing (em configuração), unknown (não foi possível determinar porque a instância está inacessível).
DBNodeCount	Integer	2	A quantidade de nós na instância.
Expired	String	false	Indica se a instância expirou. Valores válidos: true (expirada), false (não expirada).
CreateTime	String	2021-08-31T08:56:25.000+0000	O horário de criação da instância. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ss.sss+0000 e é exibido em UTC.
PayType	String	Postpaid	O método de faturamento. Valores válidos: Postpaid (pagamento conforme o uso), Prepaid (assinatura).
Port	String	3306	A porta para conexões de rede interna.
LockMode	String	Unlock	O status de bloqueio da instância. Valores válidos: Unlock (desbloqueada), ManualLock (bloqueada manualmente), LockByExpiration (bloqueada automaticamente ao expirar), LockByRestoration (bloqueada automaticamente antes de uma reversão), LockByDiskQuota (bloqueada automaticamente quando o espaço em disco se esgota), LockReadInstanceByDiskQuota (bloqueada automaticamente quando o espaço em disco se esgota; aplica-se a instâncias somente leitura).
Description	String	test instance	A descrição da instância.
ConnectionString	String	pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com	O endpoint para conexões de rede interna.
StorageUsed	Long	17042505728	A capacidade de armazenamento utilizada pela instância. Unidade: bytes.
ExpireDate	String	2022-08-31T16:00:00.000+0000	O horário de expiração da instância. Segue o padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ss.sss+0000 e é exibido em UTC.
CommodityCode	String	drds_polarxpost_public_cn	O código da mercadoria da instância. Este valor é definido automaticamente como drds_polarxpost_public_cn.
MaintainStartTime	String	06:00	O início da janela de manutenção. O horário é exibido em UTC. No console do PolarDB-X, o horário aparece em UTC+8.
MaintainEndTime	String	06:00	O fim da janela de manutenção. O horário é exibido em UTC. No console do PolarDB-X, o horário aparece em UTC+8.
DBInstanceType	String	ReadWrite	A função da instância. Valores válidos: ReadWrite (instância primária), ReadOnly (instância somente leitura).
DBNodeClass	String	polarx.x4.large.2e	O tipo de instância de cada nó.
LatestMinorVersion	String	polarx-kernel_5.4.11-16301083_xcluster-20210805	A versão secundária mais recente do kernel disponível para a instância.
DBType	String	polarx	O tipo de banco de dados da instância. Este valor é definido automaticamente como polarx.
RightsSeparationEnabled	Boolean	false	Indica se a separação de três funções está ativada. Valores válidos: true (ativada), false (desativada).
VPCId	String	vpc-xxxxx	O ID da Virtual Private Cloud (VPC) onde a instância está implantada.
MinorVersion	String	polarx-kernel_5.4.11-16301083_xcluster-20210805	A versão secundária atual do kernel da instância.
RegionId	String	cn-hangzhou	O ID da região da instância.
Network	String	VPC	O tipo de rede da instância. Este valor é definido automaticamente como VPC.
DBVersion	String	5.5	A versão do mecanismo de banco de dados.
VSwitchId	String	vsw-****	O ID do vSwitch ao qual a instância está conectada.
ZoneId	String	cn-hangzhou-a	O ID da zona da instância.
Engine	String	polarx	O tipo de mecanismo de banco de dados. Este valor é definido automaticamente como polarx.
KindCode	Integer	18	O código interno da versão do mecanismo da instância. Trata-se de um parâmetro interno.
Id	String	pxc-zkralxpc5d****	O ID da instância primária. Este parâmetro não é retornado se a instância consultada for primária.
DBNodes	Array of DBNode	—	Os nós de banco de dados da instância.
ConnAddrs	Array of ConnAddr	—	Os endpoints de conexão da instância.
ReadDBInstances	Array of String	pxr-*****	Os nomes das instâncias somente leitura associadas a esta instância.
ResourceGroupId	String	rg-*****	O ID do grupo de recursos.
TagSet	Array of TagSet	—	As tags anexadas à instância.
CnNodeCount	Integer	2	A quantidade de nós de computação na instância.
DnNodeCount	Integer	2	A quantidade de nós de dados na instância.
CnNodeClassCode	String	polarx.x4.xlarge.2e	O tipo de instância do nó de computação. Valores válidos: polarx.x4.medium.2e (2 núcleos de CPU, 8 GB de memória), polarx.x4.large.2e (4 núcleos de CPU, 16 GB de memória), polarx.x8.large.2e (4 núcleos de CPU, 32 GB de memória), polarx.x4.xlarge.2e (8 núcleos de CPU, 32 GB de memória), polarx.x8.xlarge.2e (8 núcleos de CPU, 64 GB de memória), polarx.x4.2xlarge.2e (16 núcleos de CPU, 64 GB de memória), polarx.x8.2xlarge.2e (16 núcleos de CPU, 128 GB de memória), polarx.x4.4xlarge.2e (32 núcleos de CPU, 128 GB de memória), polarx.x8.4xlarge.2e (32 núcleos de CPU, 256 GB de memória), polarx.st.8xlarge.2e (60 núcleos de CPU, 470 GB de memória), polarx.st.12xlarge.2e (90 núcleos de CPU, 720 GB de memória).
DnNodeClassCode	String	mysql.x8.large.25	O tipo de instância do nó de dados. Valores válidos: mysql.n2.medium.25 (2 núcleos de CPU, 4 GB de memória), mysql.n4.medium.25 (2 núcleos de CPU, 8 GB de memória), mysql.x8.medium.25 (2 núcleos de CPU, 16 GB de memória), mysql.n2.large.25 (4 núcleos de CPU, 8 GB de memória), mysql.n4.large.25 (4 núcleos de CPU, 16 GB de memória), mysql.x8.large.25 (4 núcleos de CPU, 32 GB de memória), mysql.n2.xlarge.25 (8 núcleos de CPU, 16 GB de memória), mysql.n4.xlarge.25 (8 núcleos de CPU, 32 GB de memória), mysql.x8.xlarge.25 (8 núcleos de CPU, 64 GB de memória), mysql.n4.2xlarge.25 (16 núcleos de CPU, 64 GB de memória), mysql.x8.2xlarge.25 (16 núcleos de CPU, 128 GB de memória), mysql.x4.4xlarge.25 (32 núcleos de CPU, 128 GB de memória), mysql.x8.4xlarge.25 (32 núcleos de CPU, 256 GB de memória), mysql.st.8xlarge.25 (60 núcleos de CPU, 470 GB de memória), mysql.st.12xlarge.25 (90 núcleos de CPU, 720 GB de memória).
Series	String	enterprise	A edição da instância. Valores válidos: enterprise (Enterprise Edition), standard (Standard Edition).
LTSVersions	Array of String	X.X.X.X	As versões com Suporte de Longo Prazo (LTS) disponíveis para a instância.
TopologyType	String	3azones	A topologia de implantação da instância. Valores válidos: 3azones (implantada em três zonas), 1azone (implantada em uma única zona).
PrimaryZone	String	cn-shenzhen-e	A zona primária da instância.
SecondaryZone	String	cn-shenzhen-a	A zona secundária da instância.
TertiaryZone	String	cn-shenzhen-e	A zona terciária da instância.

DBNode

Parâmetro	Tipo	Exemplo	Descrição
ComputeNodeId	String	pxc-i-****	O nome do nó de computação.
NodeClass	String	polarx.x4.large.2e	O tipo de instância do nó.
DataNodeId	String	pxc-xdb-xxxxxx	O nome do nó de dados.
ZoneId	String	cn-hangzhou-a	A zona onde o nó está implantado.
Id	String	pxi-*****	O ID do nó lógico.
RegionId	String	cn-hangzhou	O ID da região do nó.

ConnAddr

Parâmetro	Tipo	Exemplo	Descrição
Type	String	VPC	O tipo de conexão. Valores válidos: VPC (conectado via VPC), PUBLIC (conectado pela Internet).
VSwitchId	String	vsw-*****	O ID do vSwitch ao qual a instância está conectada.
Port	Long	3306	A porta para conexão com a instância.
VPCId	String	vpc-xxxxxx	O ID da VPC onde a instância está implantada.
ConnectionString	String	polardbx-xxx.aliyuncs.com	O endpoint para conexão com a instância.
VpcInstanceId	String	pxc-zkralxpc5d****	O ID da instância em nuvem dentro da VPC. Este parâmetro pode ser ignorado.

TagSet

Parâmetro	Tipo	Exemplo	Descrição
Key	String	key2	A chave da tag.
Value	String	value2	O valor da tag.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeDBInstanceAttribute
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&ResourceGroupId=rg-aekzaxhezhs5***
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<DescribeDBInstanceAttributeResponse>
    <RequestId>9B2F3840-5C98-475C-B269-2D5C3A31797C</RequestId>
    <DBInstance>
        <Type>ReadWrite</Type>
        <Status>Running</Status>
        <RightsSeparationStatus>disabled</RightsSeparationStatus>
        <DBNodeCount>2</DBNodeCount>
        <Expired>false</Expired>
        <CreateTime>2021-08-31T08:56:25.000+0000</CreateTime>
        <PayType>Postpaid</PayType>
        <Port>3306</Port>
        <LockMode>Unlock</LockMode>
        <Description>test instance</Description>
        <ConnectionString>pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com</ConnectionString>
        <StorageUsed>17042505728</StorageUsed>
        <ExpireDate>2022-08-31T16:00:00.000+0000</ExpireDate>
        <CommodityCode>drds_polarxpost_public_cn</CommodityCode>
        <MaintainStartTime>06:00</MaintainStartTime>
        <DBInstanceType>ReadWrite</DBInstanceType>
        <DBNodeClass>polarx.x4.large.2e</DBNodeClass>
        <LatestMinorVersion>polarx-kernel_5.4.11-16301083_xcluster-20210805</LatestMinorVersion>
        <MaintainEndTime>06:00</MaintainEndTime>
        <DBType>polarx</DBType>
        <RightsSeparationEnabled>false</RightsSeparationEnabled>
        <VPCId>vpc-xxxxx</VPCId>
        <MinorVersion>polarx-kernel_5.4.11-16301083_xcluster-20210805</MinorVersion>
        <RegionId>cn-hangzhou</RegionId>
        <Network>VPC</Network>
        <DBVersion>5.5</DBVersion>
        <VSwitchId>vsw-********</VSwitchId>
        <ZoneId>cn-hangzhou-a</ZoneId>
        <Engine>polarx</Engine>
        <KindCode>18</KindCode>
        <Id>pxc-zkralxpc5d****</Id>
        <DBNodes>
            <ComputeNodeId>pxc-i-********</ComputeNodeId>
            <NodeClass>polarx.x4.large.2e</NodeClass>
            <DataNodeId>pxc-xdb-xxxxxx</DataNodeId>
            <ZoneId>cn-hangzhou-a</ZoneId>
            <Id>pxi-*********</Id>
            <RegionId>cn-hangzhou</RegionId>
        </DBNodes>
        <ConnAddrs>
            <Type>VPC</Type>
            <VSwitchId>vsw-*********</VSwitchId>
            <Port>3306</Port>
            <VPCId>vpc-xxxxxx</VPCId>
            <ConnectionString>polardbx-xxx.aliyuncs.com</ConnectionString>
            <VpcInstanceId>pxc-zkralxpc5d****</VpcInstanceId>
        </ConnAddrs>
        <ReadDBInstances>pxr-*********</ReadDBInstances>
        <ResourceGroupId>rg-*********</ResourceGroupId>
        <TagSet>
            <Key>key2</Key>
            <Value>value2</Value>
        </TagSet>
        <CnNodeCount>2</CnNodeCount>
        <DnNodeCount>2</DnNodeCount>
        <CnNodeClassCode>polarx.x4.xlarge.2e</CnNodeClassCode>
        <DnNodeClassCode>mysql.x8.large.25</DnNodeClassCode>
        <Series>enterprise</Series>
        <LTSVersions>X.X.X.X</LTSVersions>
        <TopologyType>3azones</TopologyType>
        <PrimaryZone>cn-shenzhen-e</PrimaryZone>
        <SecondaryZone>cn-shenzhen-a</SecondaryZone>
        <TertiaryZone>cn-shenzhen-e</TertiaryZone>
    </DBInstance>
</DescribeDBInstanceAttributeResponse>

Formato JSON

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

{
  "RequestId" : "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "DBInstance" : {
    "Type" : "ReadWrite",
    "Status" : "Running",
    "RightsSeparationStatus" : "disabled",
    "DBNodeCount" : 2,
    "Expired" : "false",
    "CreateTime" : "2021-08-31T08:56:25.000+0000",
    "PayType" : "Postpaid",
    "Port" : "3306",
    "LockMode" : "Unlock",
    "Description" : "test instance",
    "ConnectionString" : "pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com",
    "StorageUsed" : 17042505728,
    "ExpireDate" : "2022-08-31T16:00:00.000+0000",
    "CommodityCode" : "drds_polarxpost_public_cn",
    "MaintainStartTime" : "06:00",
    "DBInstanceType" : "ReadWrite",
    "DBNodeClass" : "polarx.x4.large.2e",
    "LatestMinorVersion" : "polarx-kernel_5.4.11-16301083_xcluster-20210805",
    "MaintainEndTime" : "06:00",
    "DBType" : "polarx",
    "RightsSeparationEnabled" : false,
    "VPCId" : "vpc-xxxxx",
    "MinorVersion" : "polarx-kernel_5.4.11-16301083_xcluster-20210805",
    "RegionId" : "cn-hangzhou",
    "Network" : "VPC",
    "DBVersion" : "5.5",
    "VSwitchId" : "vsw-********",
    "ZoneId" : "cn-hangzhou-a",
    "Engine" : "polarx",
    "KindCode" : 18,
    "Id" : "pxc-zkralxpc5d****",
    "DBNodes" : [ {
      "ComputeNodeId" : "pxc-i-********",
      "NodeClass" : "polarx.x4.large.2e",
      "DataNodeId" : "pxc-xdb-xxxxxx",
      "ZoneId" : "cn-hangzhou-a",
      "Id" : "pxi-*********",
      "RegionId" : "cn-hangzhou"
    } ],
    "ConnAddrs" : [ {
      "Type" : "VPC",
      "VSwitchId" : "vsw-*********",
      "Port" : 3306,
      "VPCId" : "vpc-xxxxxx",
      "ConnectionString" : "polardbx-xxx.aliyuncs.com",
      "VpcInstanceId" : "pxc-zkralxpc5d****"
    } ],
    "ReadDBInstances" : [ "pxr-*********" ],
    "ResourceGroupId" : "rg-*********",
    "TagSet" : [ {
      "Key" : "key2",
      "Value" : "value2"
    } ],
    "CnNodeCount" : 2,
    "DnNodeCount" : 2,
    "CnNodeClassCode" : "polarx.x4.xlarge.2e",
    "DnNodeClassCode" : "mysql.x8.large.25",
    "Series" : "enterprise",
    "LTSVersions" : [ "X.X.X.X" ],
    "TopologyType" : "3azones",
    "PrimaryZone" : "cn-shenzhen-e",
    "SecondaryZone" : "cn-shenzhen-a",
    "TertiaryZone" : "cn-shenzhen-e"
  }
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.