DescribeDBInstanceAttribute - AnalyticDB - Centre de documentation Alibaba Cloud

Consulte les détails d'une instance AnalyticDB for PostgreSQL.

Description de l'opération

Description de l'opération.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

gpdb:DescribeDBInstanceAttribute

get

*DBInstance

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ResourceGroupId	string	Non	Ce paramètre est obsolète. Il n'est pas nécessaire de spécifier ce paramètre.	null
DBInstanceId	string	Oui	L'identifiant de l'instance. Remarque Vous pouvez appeler l'opération DescribeDBInstances pour obtenir les identifiants de toutes les instances AnalyticDB for PostgreSQL d'une région.	gp-bp13ue79qk8y1****

Éléments de réponse

Élément	Type	Description	Exemple
	object
Items	object
DBInstanceAttribute	array<object>	La liste des détails des instances.
	array<object>	Les détails.
AvailabilityValue	string	The availability status of the instance. Unit: percentage (%). Remarque This parameter is applicable only to instances in storage reservation mode.	100.0%
ConnectionMode	string	The access mode. Valid values: Performance: standard access mode. Safty: high-security access mode. LVS: LVS link mode.	LVS
ConnectionString	string	The endpoint of the instance.	gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com
CoreVersion	string	The minor version of the kernel.	mm.v6.3.10.1-202207141918
CpuCores	integer	The number of CPU cores per compute node. Unit: cores.	2
CpuCoresPerNode	integer	The number of CPU cores per node. Remarque This parameter is applicable only to instances in storage reservation mode.	0
CreationTime	string	The time when the instance was created.	2022-08-11T09:16:26Z
DBInstanceCategory	string	The instance edition. Valid values: Basic: Basic Edition. HighAvailability: High-availability Edition.	HighAvailability
DBInstanceClass	string	The instance specifications. Remarque This parameter is applicable only to instances in storage reservation mode.	gpdb.group.segsdx1
DBInstanceClassType	string	The instance family. Valid values: s: shared. x: general-purpose. d: dedicated. h: dedicated host.	x
DBInstanceCpuCores	integer	The number of CPU cores.	2
DBInstanceDescription	string	The description of the instance.	gp-bp13ue79qk8y1****
DBInstanceDiskMBPS	integer	The maximum disk throughput of the compute group. Unit: Mbit/s. Remarque This parameter is applicable only to instances in storage reservation mode.	0
DBInstanceGroupCount	string	The number of compute groups. Remarque This parameter is applicable only to instances in storage reservation mode.	0
DBInstanceId	string	The instance ID.	gp-bp13ue79qk8y1****
DBInstanceMemory	integer	The memory size of the compute node. Remarque The unit is MB for instances in storage reservation mode and GB for instances in Serverless mode or storage elastic mode.	16
DBInstanceMode	string	The resource type of the instance. Valid values: Serverless: Serverless mode. StorageElastic: storage elastic mode. Classic: storage reservation mode.	StorageElastic
DBInstanceNetType	string	This parameter is deprecated and no value is returned.	null
DBInstanceStatus	string	The instance status. For more information, see the supplementary description of the DBInstanceStatus parameter.	Running
DBInstanceStorage	integer	The maximum storage capacity per replica. Unit: GB.	50
DeployMode	string	The deployment mode.	single
EncryptionKey	string	The encryption key. Remarque This parameter is returned only for instances with cloud disk encryption enabled.	0d2470df-da7b-4786-b981-************
EncryptionType	string	The encryption type. Valid values: CloudDisk: cloud disk encryption. Remarque This parameter is returned only for instances with cloud disk encryption enabled.	CloudDisk
Engine	string	The database engine.	gpdb
EngineVersion	string	The database engine version.	6.0
ExpireTime	string	The time when the instance expires (UTC). Remarque The expiration time of a pay-as-you-go instance is `2999-09-08T16:00:00Z`.	2999-09-08T16:00:00Z
HostType	string	The machine type of the compute group. Valid values: 0: SSD 1: HDD Remarque This parameter is applicable only to instances in storage reservation mode.	0
IdleTime	integer	The wait time before the instance is released when idle. Unit: seconds. Remarque This parameter is returned only for Serverless instances in automatic scheduling mode.	600
InstanceNetworkType	string	The network type of the instance. Valid values: Classic: classic network. VPC: VPC.	VPC
LockMode	string	The lock mode. Valid values: Unlock: unlocked. ManualLock: manually locked. LockByExpiration: automatically locked upon instance expiration. LockByRestoration: automatically locked before instance rollback. LockByDiskQuota: automatically locked when the storage is full.	Unlock
LockReason	string	This parameter is deprecated and no value is returned.	null
MaintainEndTime	string	The end time of the maintenance window.	22:00Z
MaintainStartTime	string	The start time of the maintenance window.	18:00Z
MasterCU	integer	The master resources.	4
MasterNodeNum	integer	The number of master nodes.	1
MaxConnections	integer	The maximum number of concurrent connections to the instance. Remarque This parameter is applicable only to instances in storage reservation mode.	500
MemoryPerNode	integer	The memory size per replica. For the unit, see the MemoryUnit parameter. Remarque This parameter is applicable only to instances in storage reservation mode.	0
MemorySize	integer	The memory size of the compute node. Remarque The unit is MB for instances in storage reservation mode and GB for instances in Serverless mode or storage elastic mode.	16
MemoryUnit	string	The memory unit. Remarque This parameter is applicable only to instances in storage reservation mode.	GB
MinorVersion	string	The minor engine version.	6.3.10.1-202207141918
PayType	string	The billing method. Valid values: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
Port	string	The port number of the instance.	5432
ProdType	string	The product type.	standard
ReadDelayTime	string	This parameter is deprecated and no value is returned.	null
RegionId	string	The region ID.	cn-hangzhou
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-bp67acfmxazb4p****
RunningTime	string	The running duration of the instance.	4 days 22:58:55
SecurityIPList	string	This parameter is deprecated and no value is returned.	null
SegDiskPerformanceLevel	string	The performance level (PL). Only PL1 is supported.	PL1
SegNodeNum	integer	The number of segment nodes. Remarque This parameter is applicable only to instances in storage elastic mode or Serverless manual scheduling mode.	4
SegmentCounts	integer	The number of compute groups. Remarque This parameter is applicable only to instances in storage reservation mode.	0
ServerlessMode	string	The mode of the Serverless instance. Valid values: Manual: manual scheduling. Auto: automatic scheduling. Remarque This parameter is returned only for Serverless instances. The automatic scheduling mode for AnalyticDB for PostgreSQL Serverless is in invitational preview. To use this feature, submit a ticket to apply for access.	Auto
ServerlessResource	integer	The compute resource threshold. Unit: ACU. Remarque This parameter is returned only for Serverless instances in automatic scheduling mode.	32
StandbyZoneId	string	The secondary zone ID.	cn-hangzhou-i
StartTime	string	The time when the instance started running.	2022-08-11T09:26:43Z
StoragePerNode	integer	The storage size per replica. For the unit, see the StorageUnit parameter. Remarque This parameter is applicable only to instances in storage reservation mode.	0
StorageSize	integer	The storage size. Unit: GB.	50
StorageType	string	The storage type. Valid values: cloud_essd: Enterprise SSD (ESSD) cloud disk. cloud_efficiency: ultra cloud disk. Remarque This parameter is applicable only to instances in storage elastic mode.	cloud_essd
StorageUnit	string	The storage unit. Valid values: GB SSD TB SSD GB HDD Remarque This parameter is applicable only to instances in storage reservation mode.	GB SSD
SupportRestore	boolean	Indicates whether backup and restoration is supported. Valid values: true: Backup and restoration is supported. false: Backup and restoration is not supported.	true
Tags	object
Tag	array<object>	The tag key-value pairs.
	object	The tag details.
Key	string	The tag key.	test-key
Value	string	The 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	VPC ID。	vpc-bp19ame5m1r3oejns****
ZoneId	string	The zone ID.	cn-hangzhou-j
SegmentAISpec	string	The AI node specifications of the compute nodes. If the compute nodes are not AI nodes, an empty value is returned.	ADB.AIMedium.2
MasterAISpec	string	The AI node specifications of the master node. If the master node is not an AI node, an empty value is returned.	ADB.AIMedium.2
CacheStorageSize	string	The total size of the cache disk. Unit: GB.	64
InstanceSpec	string	The compute node specifications.	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	L'identifiant de la requête.	5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68

Description supplémentaire du paramètre DBInstanceStatus

Valeurs valides de DBInstanceStatus :

Creating : en cours de création.
Running : en cours d'exécution.
Deleting : en cours de suppression.
Rebooting : en cours de redémarrage.
DBInstanceClassChanging : en cours de mise à niveau ou de rétrogradation.
Transfering : en cours de migration.
EngineVersionUpgrading : version du moteur en cours de mise à niveau.
TransferingToOtherInstance : données en cours de migration vers une autre instance AnalyticDB for PostgreSQL.
GuardDBInstanceCreating : instance de reprise après sinistre en cours de création.
Restoring : en cours de restauration à partir d'une sauvegarde.
Importing : importation de données en cours.
ImportingFromOtherInstance : importation de données depuis une autre instance AnalyticDB for PostgreSQL en cours.
DBInstanceNetTypeChangin : type de réseau en cours de modification.
GuardSwitching : basculement de reprise après sinistre en cours.

Exemples

JSON format

{
  "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"
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.