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

Consulta os detalhes de uma instância do AnalyticDB for PostgreSQL.

Descrição da operação

Como fazer

Esta API é normalmente usada para visualizar informações como as especificações, o tipo de rede e o status de uma instância do AnalyticDB for PostgreSQL.

Limite de consultas por segundo (QPS)

O limite padrão de QPS para esta API é de 1000 consultas por segundo por usuário. Se esse limite for excedido, as chamadas de API serão limitadas por taxa, o que pode afetar suas operações de negócios. Invoque a API de forma adequada.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

gpdb:DescribeDBInstanceAttribute

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ResourceGroupId	string	Não	Este parâmetro foi descontinuado e não precisa ser especificado.	null
DBInstanceId	string	Sim	O ID da instância. Nota Você pode invocar a API DescribeDBInstances para visualizar os IDs de todas as instâncias do AnalyticDB for PostgreSQL na região de destino.	gp-bp13ue79qk8y1****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Items	object
DBInstanceAttribute	array<object>	Lista de detalhes da instância.
	array<object>	Detalhes.
AvailabilityValue	string	Queries the current instance availability status, in percentage (%). Nota This parameter applies only to instances in reserved storage mode.	100.0%
ConnectionMode	string	Access mode. Valid values: Performance: Standard access mode. Safty: High-security access mode. LVS: LVS link mode.	LVS
ConnectionString	string	Connection address of the instance.	gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com
CoreVersion	string	The minor engine version number.	mm.v6.3.10.1-202207141918
CpuCores	integer	Number of CPU cores on the compute node, in cores.	2
CpuCoresPerNode	integer	The number of CPU cores per node. Nota This parameter applies only to instances in reserved storage mode.	0
CreationTime	string	Creation Time of the instance.	2022-08-11T09:16:26Z
DBInstanceCategory	string	The instance edition. Valid values: Basic: Basic Edition. HighAvailability: High-availability Edition.	HighAvailability
DBInstanceClass	string	Instance type. Nota This parameter applies only to instances in storage reserved mode.	gpdb.group.segsdx1
DBInstanceClassType	string	The instance family. Valid values: s: Shared type. x: General-purpose type. d: Dedicated plan. h: Dedicated physical machine.	x
DBInstanceCpuCores	integer	Number of CPU cores.	2
DBInstanceDescription	string	Instance description.	gp-bp13ue79qk8y1****
DBInstanceDiskMBPS	integer	Maximum BPS (disk throughput) of the compute group, in Mbps. Nota This parameter applies only to instances in storage-reserved mode.	0
DBInstanceGroupCount	string	The number of compute groups. Nota This parameter applies only to instances in reserved storage mode.	0
DBInstanceId	string	Instance ID.	gp-bp13ue79qk8y1****
DBInstanceMemory	integer	The memory of the compute node. Nota The unit is MB for reserved storage mode, and GB for Serverless and elastic storage modes.	16
DBInstanceMode	string	Resource type of the instance. Valid values: Serverless: Serverless mode. StorageElastic: Storage elasticity mode. Classic: Reserved storage mode.	StorageElastic
DBInstanceNetType	string	This parameter is deprecated and will not return a value.	null
DBInstanceStatus	string	Instance status. For more information, see the supplementary description of the DBInstanceStatus parameter.	Running
DBInstanceStorage	integer	Maximum storage space per replica, in GB.	50
DeployMode	string	Deployment mode	single
EncryptionKey	string	Encryption Key. Nota This parameter is returned only for instances with disk encryption enabled.	0d2470df-da7b-4786-b981-************
EncryptionType	string	Encryption Type. Valid values: CloudDisk: disk encryption. Nota This parameter is returned only for instances with disk encryption enabled.	CloudDisk
Engine	string	Database engine.	gpdb
EngineVersion	string	Database version.	6.0
ExpireTime	string	Expiration Time of the instance (UTC). Nota The expiration time for a pay-as-you-go instance is `2999-09-08T16:00:00Z`.	2999-09-08T16:00:00Z
HostType	string	Compute group machine type. Valid values: 0: SSD 1: HDD Nota This parameter applies only to instances in storage reservation mode.	0
IdleTime	integer	Idle release waiting duration. The unit is seconds. Nota This parameter is returned only for instances in Serverless auto-scheduling mode.	600
InstanceNetworkType	string	The network type of the instance. Valid values: Classic: classic network. VPC: VPC network.	VPC
LockMode	string	The lock mode. Valid values: Unlock: Normal. ManualLock: Locked manually. LockByExpiration: Automatically locked when the instance expires. LockByRestoration: Automatically locked before instance rollback. LockByDiskQuota: Automatically locked when the instance storage space is full.	Unlock
LockReason	string	This parameter is deprecated and therefore no parameter value will be returned.	null
MaintainEndTime	string	Maintenance end time.	22:00Z
MaintainStartTime	string	Start time of the maintenance window.	18:00Z
MasterCU	integer	Master resources.	4
MasterNodeNum	integer	Quantity of master nodes.	1
MaxConnections	integer	Maximum number of concurrent connections for the instance. Nota This parameter applies only to instances in storage reserved mode.	500
MemoryPerNode	integer	The memory size per replica. For the unit, see the MemoryUnit parameter. Nota This parameter applies only to instances in reserved storage mode.	0
MemorySize	integer	Memory size of the compute node. Nota The unit is MB for reserved storage mode, and GB for Serverless and elastic storage modes.	16
MemoryUnit	string	Memory unit. Nota This parameter applies only to instances in reserved storage mode.	GB
MinorVersion	string	Minor engine version.	6.3.10.1-202207141918
PayType	string	The billing type. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
Port	string	The port number of the instance.	5432
ProdType	string	Product type	standard
ReadDelayTime	string	This parameter is deprecated and therefore no value will be returned.	null
RegionId	string	Region ID.	cn-hangzhou
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-bp67acfmxazb4p****
RunningTime	string	Running duration of the instance.	4 days 22:58:55
SecurityIPList	string	This parameter is deprecated and will not return a value.	null
SegDiskPerformanceLevel	string	Performance level (PL). Only PL1 is currently supported.	PL1
SegNodeNum	integer	The number of segment nodes. Nota This parameter applies only to instances in elastic storage mode and Serverless mode with manual scheduling.	4
SegmentCounts	integer	Number of compute groups. Nota This parameter applies only to instances in storage-reserved mode.	0
ServerlessMode	string	Serverless instance mode. Valid values: Manual: manual schedule. Auto: auto schedule. Nota This parameter is returned only for Serverless instances. The auto schedule mode for AnalyticDB for PostgreSQL Serverless is currently in invitational preview. To use this feature, submit a ticket to request access.	Auto
ServerlessResource	integer	Computing resource threshold, measured in ACUs. Nota This parameter is returned only for instances in Serverless auto-scheduling mode.	32
StandbyZoneId	string	Secondary zone ID.	cn-hangzhou-i
StartTime	string	The time when the instance started running.	2022-08-11T09:26:43Z
StoragePerNode	integer	Storage size per replica. For the unit, see the StorageUnit parameter. Nota This parameter applies only to instances in reserved storage mode.	0
StorageSize	integer	Bucket size, in GB.	50
StorageType	string	Storage class. Valid values: cloud_essd: enterprise SSD (ESSD). cloud_efficiency: ultra disk. Nota This parameter applies only to instances in storage elasticity mode.	cloud_essd
StorageUnit	string	Storage unit. Valid values: GB SSD TB SSD GB HDD Nota This parameter applies only to instances in reserved storage mode.	GB SSD
SupportRestore	boolean	Indicates whether backup recovery is supported. Valid values: true: Backup recovery is supported. false: Backup recovery is not supported.	true
Tags	object
Tag	array<object>	Key-value pairs of tags.
	object	Tag details are as follows.
Key	string	Tag key.	test-key
Value	string	Tag value.	test-value
VSwitchId	string	vSwitch ID.	vsw-bp1cpq8mr64paltkb****
VectorConfigurationStatus	string	Indicates whether vector engine optimization is enabled. Valid values: enabled: Vector engine optimization is enabled. disabled: Vector engine optimization is disabled.	enabled
VpcId	string	The VPC ID.	vpc-bp19ame5m1r3oejns****
ZoneId	string	Zone ID.	cn-hangzhou-j
SegmentAISpec	string	The compute AI node specifications of the instance. If the compute node is not an AI node, an empty value is returned.	ADB.AIMedium.2
MasterAISpec	string	Returns the master AI node specifications of the instance. If the master node is not an AI node, an empty value is returned.	ADB.AIMedium.2
CacheStorageSize	string	Total cache disk size, in GB.	64
InstanceSpec	string	Node specifications of the compute node.	2C16G
GraphEngineStatus	string	Indicates whether the graph engine is enabled. Valid values: enabled: The graph engine is enabled. disabled: The graph engine is disabled.	enabled
RequestId	string	O ID da solicitação.	5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68

Descrição adicional do parâmetro DBInstanceStatus

O parâmetro DBInstanceStatus pode ter os seguintes valores:

Creating: Criação em andamento.
Running: Em uso.
Deleting: Exclusão em andamento.
Rebooting: Reinicialização em andamento.
DBInstanceClassChanging: Escalonamento para cima ou para baixo em andamento.
Transfering: Migração em andamento.
EngineVersionUpgrading: Atualização de versão em andamento.
TransferingToOtherInstance: Migrando dados para outra instância do AnalyticDB for PostgreSQL.
GuardDBInstanceCreating: Criando uma instância de recuperação de desastres.
Restoring: Restauração de backup em andamento.
Importing: Importação de dados em andamento.
ImportingFromOtherInstance: Importando dados de outra instância do AnalyticDB for PostgreSQL.
DBInstanceNetTypeChangin: Alternando entre os tipos de rede interna e pública.
GuardSwitching: Switchover em andamento.

Exemplos

Resposta de sucesso

JSON formato

{
  "Items": {
    "DBInstanceAttribute": [
      {
        "AvailabilityValue": "100.0%",
        "ConnectionMode": "LVS",
        "ConnectionString": "gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com",
        "CoreVersion": "mm.v6.3.10.1-202207141918",
        "CpuCores": 2,
        "CpuCoresPerNode": 0,
        "CreationTime": "2022-08-11T09:16:26Z",
        "DBInstanceCategory": "HighAvailability",
        "DBInstanceClass": "gpdb.group.segsdx1",
        "DBInstanceClassType": "x",
        "DBInstanceCpuCores": 2,
        "DBInstanceDescription": "gp-bp13ue79qk8y1****",
        "DBInstanceDiskMBPS": 0,
        "DBInstanceGroupCount": "0",
        "DBInstanceId": "gp-bp13ue79qk8y1****",
        "DBInstanceMemory": 16,
        "DBInstanceMode": "StorageElastic",
        "DBInstanceNetType": "null",
        "DBInstanceStatus": "Running",
        "DBInstanceStorage": 50,
        "DeployMode": "single",
        "EncryptionKey": "0d2470df-da7b-4786-b981-************",
        "EncryptionType": "CloudDisk",
        "Engine": "gpdb",
        "EngineVersion": "6.0",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "HostType": "0",
        "IdleTime": 600,
        "InstanceNetworkType": "VPC",
        "LockMode": "Unlock",
        "LockReason": "null",
        "MaintainEndTime": "22:00Z",
        "MaintainStartTime": "18:00Z",
        "MasterCU": 4,
        "MasterNodeNum": 1,
        "MaxConnections": 500,
        "MemoryPerNode": 0,
        "MemorySize": 16,
        "MemoryUnit": "GB",
        "MinorVersion": "6.3.10.1-202207141918",
        "PayType": "Postpaid",
        "Port": "5432",
        "ProdType": "standard",
        "ReadDelayTime": "null",
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "RunningTime": "4 days 22:58:55",
        "SecurityIPList": "null",
        "SegDiskPerformanceLevel": "PL1",
        "SegNodeNum": 4,
        "SegmentCounts": 0,
        "ServerlessMode": "Auto",
        "ServerlessResource": 32,
        "StandbyZoneId": "cn-hangzhou-i",
        "StartTime": "2022-08-11T09:26:43Z",
        "StoragePerNode": 0,
        "StorageSize": 50,
        "StorageType": "cloud_essd",
        "StorageUnit": "GB SSD",
        "SupportRestore": true,
        "Tags": {
          "Tag": [
            {
              "Key": "test-key",
              "Value": "test-value"
            }
          ]
        },
        "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
        "VectorConfigurationStatus": "enabled",
        "VpcId": "vpc-bp19ame5m1r3oejns****",
        "ZoneId": "cn-hangzhou-j",
        "SegmentAISpec": "ADB.AIMedium.2",
        "MasterAISpec": "ADB.AIMedium.2",
        "CacheStorageSize": "64",
        "InstanceSpec": "2C16G",
        "GraphEngineStatus": "enabled"
      }
    ]
  },
  "RequestId": "5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.