DescribeDBInstanceAttribute - - Centre de documentation Alibaba Cloud

Consulte les détails d'une instance.

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.

selectdb:DescribeDBInstanceAttribute

list

*Toutes les ressources.

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBInstanceId	string	Oui	L'identifiant de l'instance.	selectdb-cn-7213cjv****
RegionId	string	Oui	L'identifiant de la région.	cn-hangzhou

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
CanUpgradeVersionCommunityMap	object
	string
CanUpgradeVersions	array	La liste des versions pouvant être mises à niveau.
	string	La liste des versions pouvant être mises à niveau.	test
ChargeType	string	La méthode de facturation de l'instance. Valeurs valides : Postpaid : paiement à l'usage. Prepaid : abonnement.	Prepaid
CommunityVersion	string
ConfigPatternType	string	Le modèle de configuration appliqué à l'instance.	log
CreateTime	string	L'heure de création au format ISO 8601, incluant les informations de fuseau horaire.	2023-08-14T03:00:42Z
DBClusterList	array<object>	La liste des clusters auxquels l'instance appartient.
	object	Les informations du cluster.
CacheStorageSizeGB	string	La taille du stockage de cache. Unité : Go.	200
CacheStorageType	string	Le type de stockage de cache.	cloud_essd
ChargeType	string	La méthode de facturation du cluster. Valeurs valides : Postpaid : paiement à l'usage. Prepaid : abonnement.	Prepaid
ClusterBinding	string	Le cluster cible lié.	selectdb-cn-7213cjv****-be
ClusterNodeCount	integer	Le nombre de nœuds dans le cluster. Ce paramètre n'est valide que pour les clusters serverless.	1
ClusterNodeType	string	Le type de nœud du cluster. Ce paramètre n'est valide que pour les clusters serverless. Valeurs valides : base : Le ratio CPU/mémoire d'une SCU est de 1:4.	base
CpuCores	integer	Le nombre de cœurs de processeur.	8
CreatedTime	string	L'heure de création du cluster au format ISO 8601, incluant les informations de fuseau horaire.	2023-08-14T09:24:13Z
DbClusterClass	string	Les spécifications du cluster. Valeurs valides : selectdb.xlarge : 4 cœurs et 16 Go de mémoire. selectdb.2xlarge : 8 cœurs et 32 Go de mémoire. selectdb.4xlarge : 16 cœurs et 64 Go de mémoire. selectdb.8xlarge : 32 cœurs et 128 Go de mémoire. selectdb.16xlarge : 64 cœurs et 256 Go de mémoire. selectdb.24xlarge : 96 cœurs et 384 Go de mémoire. selectdb.32xlarge : 128 cœurs et 512 Go de mémoire.	selectdb.2xlarge
DbClusterId	string	L'identifiant du cluster.	selectdb-cn-h033cjs****-be
DbClusterName	string	Le nom du cluster.	test01
DbInstanceName	string	Le nom de l'instance.	Test instance
Memory	integer	La taille de la mémoire.	64
ModifiedTime	string	L'heure de mise à jour au format ISO 8601, incluant les informations de fuseau horaire.	2024-07-02T16:35:44+08:00
PerformanceLevel	string	Le niveau de performance.	PL1
ScaleMax	number	Le nombre maximal d'unités de capacité RDS (RCU) pour la mise à l'échelle automatique de l'instance.	4
ScaleMin	number	Le nombre minimal d'unités de capacité RDS (RCU) pour la mise à l'échelle automatique de l'instance.	0.5
ScalingRulesEnable	boolean	Indique si la stratégie élastique basée sur le temps est activée.	false
StartTime	string	L'heure de démarrage du cluster au format ISO 8601, incluant les informations de fuseau horaire.	2023-08-14T09:24:13Z
Status	string	L'état du cluster. Valeurs valides : CREATING : en cours de création. ACTIVATION : en cours d'exécution. RESOURCE_CHANGING : modification des spécifications. ORDER_PREPARING : préparation de la commande. READONLY_RESOURCE_CHANGING : modification des ressources (instance verrouillée en écriture). DELETING : en cours de suppression.	ACTIVATION
SubDomain	string	Le sous-domaine.	Reserved parameter. Not returned
VSwitchId	string	L'identifiant du vSwitch.	vsw-t4n8x7jcc8rknon85tqoa
ZoneId	string	L'identifiant de la zone.	cn-hangzhou-k
DBInstanceId	string	L'identifiant de l'instance.	selectdb-cn-7213cjv****
DeployScheme	string	Le mode de déploiement de l'instance.	multi_az
Description	string	La description de l'instance.	test
Engine	string	Le moteur de base de données.	selectdb
EngineMinorVersion	string	La version mineure du moteur de l'instance.	3.0.1
EngineVersion	string	La version de la base de données.	2.4
ExpireTime	string	L'heure d'expiration de l'instance, au format ISO 8601, incluant les informations de fuseau horaire.	2023-09-17T00:00Z
FEClusterList	array<object>	La liste des clusters FE.
	object	Les informations sur le cluster FE.
DbClusterId	string	Le nom du cluster FE.
NodeCount	integer	Le nombre de nœuds dans le cluster FE.	0
SingleNodeCpuCores	integer	Le nombre de cœurs de processeur par nœud dans le cluster FE.	0
SingleNodeMemoryInGB	integer	La mémoire par nœud dans le cluster FE. Unité : Go.	0
Status	string	L'état du cluster FE.
GmtModified	string	L'heure à laquelle l'instance a été modifiée, par exemple lors d'un redémarrage ou d'une demande de point de terminaison public. L'heure est affichée au format yyyy-MM-ddTHH:mmZ (UTC).	2023-08-17T09:58Z
LangfuseInstanceIds	array	La liste des identifiants des instances Langfuse associées à l'instance SelectDB.	["lfu-xxkshuf23sdj"]
	string	L'identifiant de l'instance Langfuse associée à l'instance SelectDB.	lfu-xxkshuf23sdj
LockMode	integer	Le mode de verrouillage de l'instance. La valeur lock indique que l'instance est verrouillée en raison de son expiration ou d'un retard de paiement.	lock
LockReason	string	La raison pour laquelle l'instance est verrouillée.	nolock
MCPServerServiceStatus	string	L'état du service du serveur MCP.	not_enabled
MaintainEndtime	string	Ce paramètre est réservé et n'est pas renvoyé. Le format de l'heure ne s'applique pas.	Reserved parameter, not returned
MaintainStarttime	string	Ce paramètre est réservé et n'est pas renvoyé. Le format de l'heure ne s'applique pas.	Reserved parameter, not returned
MultiZone	array<object>	La configuration multizone. Remarque Ce paramètre prend effet lorsque DeployScheme est défini sur multi_az.
	object	La liste multizone.
AvailableIpCount	integer	Le nombre d'adresses IP disponibles dans la zone.	4096
Cidr	string	Les informations CIDR de l'entrée de liste de préfixes.	113.88.14.211/32
VSwitchIds	array	La liste des identifiants de vSwitch.
	string	L'identifiant du vSwitch.	vsw-bp10dbralpn4bzmgkkh8f
ZoneId	string	L'identifiant de la zone.	cn-hangzhou-k
OTelBearerToken	string	Le jeton porteur du collecteur OTel.
OTelGrafanaServiceStatus	string	L'état du service du collecteur OTel et de Grafana.
ObjectStoreSize	integer	L'espace de stockage.	0
RegionId	string	L'identifiant de la région.	cn-beijing
RequestId	string	L'identifiant de la requête.	06758CAB-1204-5852-A471-29C87D5C1D0F
ResourceCpu	integer	Le nombre de ressources processeur.	8
ResourceGroupId	string	L'identifiant du groupe de ressources auquel l'instance appartient.	rg-aekzbck4asz3dsa
SecGroupConnValid	string	Indique si la fonctionnalité de connexion directe au port est activée pour le VPC où réside l'instance actuelle. La valeur true indique que la fonctionnalité de connexion directe au port est activée. La valeur false indique que la fonctionnalité de connexion directe au port est désactivée.	false
Serverless	boolean	Indique si la fonctionnalité serverless est activée pour l'instance actuelle. La valeur true indique que la fonctionnalité serverless est activée. La valeur false indique que la fonctionnalité serverless est désactivée.	false
Status	string	L'état de l'instance. Valeurs valides : CREATING : l'instance est en cours de création. ACTIVE : l'instance est en cours d'exécution. RESOURCE_CHANGING : les spécifications de l'instance sont en cours de modification. ORDER_PREPARING : la commande est en cours de confirmation. READONLY_RESOURCE_CHANGING : les ressources de l'instance sont en cours de modification et l'instance est verrouillée en écriture. DELETING : l'instance est en cours de suppression.	ACTIVE
StorageSize	integer	La capacité de stockage.	400
SubDomain	string	La zone.	cn-beijing-h-aliyun
Tags	array<object>	Les informations de la liste des balises de l'instance.
	object	La balise de l'instance.
TagKey	string	La clé de balise.	testKey
TagValue	string	La valeur de balise.	testValue
VSwitchId	string	L'identifiant du vSwitch.	vsw-bp18iztwqrs8qj2nc6nyu
VirtualClusterList	array<object>	La liste des clusters virtuels.
	object
ActiveClusterId	string	L'identifiant du cluster principal.	selectdb-xx78***-be
ActiveClusterName	string	Le nom du cluster principal.	test1
CreatedTime	string	L'heure de création au format ISO 8601, incluant les informations de fuseau horaire.	2025-05-31T21:01:09Z
DbClusterId	string	L'identifiant du cluster.	selectdb-vcg-33cjs****-be
DbClusterName	string	Le nom du cluster.	vgcdemo
StandbyClusterId	string	L'identifiant du cluster de secours.	selectdb-x6u7***-be
StandbyClusterName	string	Le nom du cluster de secours.	test2
Status	string	L'état de l'instance. Valeurs valides : CREATING : L'instance est en cours de création. RUNNING : L'instance est en cours d'exécution. DELETING : L'instance est en cours de suppression. UPDATING : L'instance est en cours de mise à jour.	UPDATING
VpcId	string	L'identifiant du VPC de l'instance.	vpc-bp175iuvg8nxqraf2****
ZoneId	string	L'identifiant de la zone de l'instance.	cn-beijing-h

Exemples

JSON format

{
  "CanUpgradeVersionCommunityMap": {
    "key": ""
  },
  "CanUpgradeVersions": [
    "test"
  ],
  "ChargeType": "Prepaid",
  "CommunityVersion": "",
  "ConfigPatternType": "log",
  "CreateTime": "2023-08-14T03:00:42Z",
  "DBClusterList": [
    {
      "CacheStorageSizeGB": "200",
      "CacheStorageType": "cloud_essd",
      "ChargeType": "Prepaid",
      "ClusterBinding": "selectdb-cn-7213cjv****-be",
      "ClusterNodeCount": 1,
      "ClusterNodeType": "base",
      "CpuCores": 8,
      "CreatedTime": "2023-08-14T09:24:13Z",
      "DbClusterClass": "selectdb.2xlarge",
      "DbClusterId": "selectdb-cn-h033cjs****-be",
      "DbClusterName": "test01",
      "DbInstanceName": "Instance test",
      "Memory": 64,
      "ModifiedTime": "2024-07-02T16:35:44+08:00",
      "PerformanceLevel": "PL1",
      "ScaleMax": 4,
      "ScaleMin": 0.5,
      "ScalingRulesEnable": false,
      "StartTime": "2023-08-14T09:24:13Z",
      "Status": "ACTIVATION",
      "SubDomain": "Paramètre réservé. Non renvoyé",
      "VSwitchId": "vsw-t4n8x7jcc8rknon85tqoa",
      "ZoneId": "cn-hangzhou-k"
    }
  ],
  "DBInstanceId": "selectdb-cn-7213cjv****",
  "DeployScheme": "multi_az",
  "Description": "test",
  "Engine": "selectdb",
  "EngineMinorVersion": "3.0.1",
  "EngineVersion": "2.4",
  "ExpireTime": "2023-09-17T00:00Z",
  "FEClusterList": [
    {
      "DbClusterId": "",
      "NodeCount": 0,
      "SingleNodeCpuCores": 0,
      "SingleNodeMemoryInGB": 0,
      "Status": ""
    }
  ],
  "GmtModified": "2023-08-17T09:58Z",
  "LangfuseInstanceIds": [
    "lfu-xxkshuf23sdj"
  ],
  "LockMode": 0,
  "LockReason": "nolock",
  "MCPServerServiceStatus": "not_enabled",
  "MaintainEndtime": "Paramètre réservé",
  "MaintainStarttime": "Paramètre réservé",
  "MultiZone": [
    {
      "AvailableIpCount": 4096,
      "Cidr": "113.88.14.211/32",
      "VSwitchIds": [
        "vsw-bp10dbralpn4bzmgkkh8f"
      ],
      "ZoneId": "cn-hangzhou-k"
    }
  ],
  "OTelBearerToken": "",
  "OTelGrafanaServiceStatus": "",
  "ObjectStoreSize": 0,
  "RegionId": "cn-beijing",
  "RequestId": "06758CAB-1204-5852-A471-29C87D5C1D0F",
  "ResourceCpu": 8,
  "ResourceGroupId": "rg-aekzbck4asz3dsa",
  "SecGroupConnValid": "false",
  "Serverless": false,
  "Status": "ACTIVE",
  "StorageSize": 400,
  "SubDomain": "Paramètre réservé",
  "Tags": [
    {
      "TagKey": "testKey",
      "TagValue": "testValue"
    }
  ],
  "VSwitchId": "vsw-bp18iztwqrs8qj2nc6nyu",
  "VirtualClusterList": [
    {
      "ActiveClusterId": "selectdb-xx78***-be",
      "ActiveClusterName": "test1",
      "CreatedTime": "2025-05-31T21:01:09Z",
      "DbClusterId": "selectdb-vcg-33cjs****-be",
      "DbClusterName": "vgcdemo",
      "StandbyClusterId": "selectdb-x6u7***-be",
      "StandbyClusterName": "test2",
      "Status": "UPDATING"
    }
  ],
  "VpcId": "vpc-bp175iuvg8nxqraf2****",
  "ZoneId": "cn-beijing-h"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	DocumentConvertFailed.ExceedFileSizeLimit	The conversion has been failed, exceed file size limit.	La conversion du document a échoué car la taille du fichier dépasse la limite du système.
400	Forbidden	User not authorized to operate on the specified resource, or this API does not support RAM.	L'utilisateur RAM ne dispose pas des autorisations requises. Accordez d'abord les autorisations nécessaires.
400	InvalidDBName	The specified database name is not allowed.	Le nom de la base de données ne répond pas aux exigences. Vérifiez que le nom de la base de données est correct.
400	CreateOrderFailed	Failed to create order.	Échec de la création de la commande.
400	InvalidDBName.Duplicate	Specified DB name already exists in the This instance.	Le nouveau nom de cluster existe déjà.
403	DBClusterNotSupported	The requested operation can not be performed while the cluster is not sale.	L'opération demandée ne peut pas être effectuée lorsque le cluster n'est pas en cours d'exécution.
403	IncorrectDBInstanceState	Current DB instance state does not support this operation.	L'état actuel de l'instance ne prend pas en charge cette opération.
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.	L'opération a échoué car le moteur et le type de l'instance ne prennent pas en charge cette opération.
403	InvalidDBInstanceState.NotSupport	The specified instance state does't support this operation.	L'état de l'instance spécifié ne prend pas en charge cette opération.
403	MoneyLessThan100	The Account Monet less Than 100.	Le solde actuel du compte Alibaba Cloud est inférieur à 100. Rechargez votre compte.
403	OperationDenied.DBNameAndAccountPrivilegeCount	The operation is not permitted due to count of database or account privilege.	L'opération a échoué car le nombre de bases de données ne correspond pas au nombre d'autorisations.
403	InsufficientResourceCapacity	The resource is out of usage.	Les ressources sont insuffisantes. Réessayez plus tard.
404	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in our records.	L'instance SelectDB n'existe pas.
404	InvalidClusterInstance.NotFound	Specified cluster instance does not exist.	L'instance SelectDB n'existe pas.
404	DBInstanceLocked	The current instance lock mode does not support this operation.	L'opération a échoué car l'instance actuelle est verrouillée.
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.	Le paramètre vSwitch n'est pas valide.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	InvalidDBInstance.NotFound	The specified instance is not found.	L'instance spécifiée n'a pas été trouvée. Vérifiez que l'identifiant de l'instance est correct.
404	InvalidDBInstanceClass.NotFound	The specified instance classic does not exist.	La configuration ou le type d'instance sélectionné n'existe pas ou n'est plus disponible. Sélectionnez-en un autre.
404	InvalidRegionId.NotFound	The provided RegionId does not exist in our records.	L'opération a échoué car la région et la zone spécifiées n'existent pas.
404	QueryPrice.Failed	The inquiry failed. Contact Alibaba Cloud customer service representatives.	La demande de prix a échoué. Contactez le service client.

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

Notes de version

Consultez Notes de version pour la liste complète.