DescribeInstance - ApsaraDB for OceanBase (Deprecated) - Centre de documentation Alibaba Cloud

Consulte les détails d'un cluster OceanBase.

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.

oceanbase:DescribeInstance

get

*Instance

acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant du cluster OceanBase.	ob317v4uif****
PageNumber	integer	Non	Numéro de page pour la requête paginée.	1

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le résultat de la requête.
RequestId	string	L'identifiant de la requête.	EE205C00-30E4-**-**-87E3A8A2AA0C
Instance	object	Les informations du cluster OceanBase.
InstanceId	string	L'identifiant du cluster OceanBase.	ob317v4uif****
InstanceName	string	Le nom du cluster OceanBase.	ob4test
InstanceClass	string	Les spécifications du cluster. Les plans suivants sont pris en charge : 4C16GB : 4 cœurs, 16 Go. 8C32GB : 8 cœurs, 32 Go. 14C70GB : 14 cœurs, 70 Go. 24C120GB : 24 cœurs, 120 Go. 30C180GB : 30 cœurs, 180 Go. 62C400GB : 62 cœurs, 400 Go. 104C600GB : 104 cœurs, 600 Go. 16C70GB : 16 cœurs, 70 Go. 32C160GB : 32 cœurs, 160 Go. 64C380GB : 64 cœurs, 380 Go. 20C32GB : 20 cœurs, 32 Go. 40C64GB : 40 cœurs, 64 Go. 16C32GB : 16 cœurs, 32 Go. 32C70GB : 32 cœurs, 70 Go. 64C180GB : 64 cœurs, 180 Go. 32C180GB : 32 cœurs, 180 Go. 64C400GB : 64 cœurs, 400 Go.	14C70G
Series	string	La série de l'instance. normal (par défaut) : Édition Cluster Standard (disque cloud). normal_ssd : Édition Cluster Standard (disque local). history : Édition Cluster de base de données d'archivage. normal_kv : cluster OBKV. normal_hg : cluster d'applications innovantes.	Normal
PayType	string	Le mode de facturation du cluster OceanBase. PREPAY : abonnement. POSTPAY : paiement à l'usage.	PREPAY
CreateTime	string	L'heure de création du cluster. L'heure est au format UTC.	2021-10-19T07:13:41Z
ExpireTime	string	L'heure d'expiration du cluster. L'heure est au format UTC.	2021-10-17T16:00:00Z
Version	string	La version d'OBServer.	2.2.77
DeployType	string	Le type de déploiement du cluster. multiple : multi-centre de données. single : centre de données unique. dual : double centre de données.	multiple
DeployMode	string	Le mode de réplication des données du cluster. n pour un centre de données unique. n-n pour deux centres de données. n-n-n pour plusieurs centres de données. Remarque Dans ce mode, n indique le nombre de nœuds OBServer dans chaque centre de données.	1-1-1
DiskType	string	La classe de stockage du cluster. La valeur par défaut est cloud_essd_pl1, qui correspond à un disque cloud ESSD.	cloud_essd_pl1
MaintainTime	string	La fenêtre de maintenance quotidienne du cluster. L'heure est au format UTC.	19:00Z-20:00Z
DataMergeTime	string	L'heure de fusion des données du cluster.	02:00
AutoRenewal	boolean	Indique si le renouvellement automatique est activé. Ce paramètre n'est valide que pour les clusters par abonnement.	true
IsTrustEcs	boolean	Indique si une instance ECS de confiance est utilisée.	true
Status	string	L'état du cluster. PENDING_CREATE : L'instance est en cours de création. ONLINE : L'instance est en cours d'exécution. TENANT_CREATING : Un tenant est en cours de création. TENANT_SPEC_MODIFYING : Les spécifications du tenant sont en cours de modification. EXPANDING : Le nombre de nœuds est en cours d'augmentation. REDUCING : Le nombre de nœuds est en cours de réduction. SPEC_UPGRADING : Les spécifications de l'instance sont en cours de mise à niveau. DISK_UPGRADING : La capacité de stockage est en cours d'augmentation. WHITE_LIST_MODIFYING : La liste blanche est en cours de modification. PARAMETER_MODIFYING : Les paramètres sont en cours de modification. SSL_MODIFYING : Le certificat SSL est en cours de modification. PREPAID_EXPIRE_CLOSED : Le cluster par abonnement est suspendu en raison d'un retard de paiement. ARREARS_CLOSED : Le cluster à la demande est suspendu en raison d'un retard de paiement. PENDING_DELETE : L'instance est en cours de suppression. Le cluster est généralement dans l'état ONLINE.	ONLINE
Resource	object	Les informations sur les ressources du cluster.
Cpu	object	The CPU resource information of the cluster.
TotalCpu	integer	The total number of CPU cores of the cluster.	14
UsedCpu	integer	The number of used CPU cores of the cluster.	10
UnitCpu	integer	The number of CPU cores of each replica node in the cluster.	10
OriginalTotalCpu	integer	The original number of CPU cores.	14
Memory	object	The memory resource information of the cluster.
TotalMemory	integer	The total memory of the cluster, in GB.	70
UsedMemory	integer	The used memory of the cluster, in GB.	10
UnitMemory	integer	The memory of each replica in the cluster, in GB.	10
OriginalTotalMemory	integer	The original memory size.	72
DiskSize	object	The storage resource information of the cluster.
TotalDiskSize	integer	The total storage space of the cluster, in GB.	200
UsedDiskSize	integer	The used storage space of the cluster, in GB.	100
UnitDiskSize	integer	The storage space of each replica in the cluster, in GB.	200
DataUsedSize	number	The size of the data disk, in GB.	200
MaxDiskUsedPercent	number	The maximum disk usage, in percentage.	0.14
MaxDiskUsedObServer	array	The maximum disk usage of the server.
	string	The list of OBServer nodes with the highest data disk usage.	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	The original disk size.	200
MaxDiskSize	number	The maximum disk size that can be created.	80000
UnitCount	integer	The number of resource units in the cluster.	1
LogDiskSize	object	The log disk resource information of the cluster.
TotalDiskSize	integer	The total log disk space of the cluster, in GB.	400
UnitDiskSize	integer	The log storage space of each replica in the cluster, in GB.	200
LogAssignedSize	string	The allocated log storage space, in GB.	0.0
MaxLogAssignedObServer	array	The information about the maximum storage space allocated to the server.
	string	The list of OBServer nodes with the highest log disk usage.	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	The maximum percentage of allocated log storage space.	6.68
OriginalTotalDiskSize	integer	The original size of the log disk.	200
CapacityUnit	object	The capacity unit.
MaxCapacityUnit	integer	The maximum capacity unit.	4
MinCapacityUnit	integer	The minimum capacity unit.	1
UsedCapacityUnit	string	The used capacity unit.	2
AutoUpgradeObVersion	boolean	Indique si la version d'OBServer doit être mise à niveau automatiquement.	true
ObRpmVersion	string	Les informations détaillées sur la version d'OBServer.	2.2.77-20210526202046
IsLatestObVersion	boolean	Indique si OBServer est dans sa version la plus récente.	true
AvailableZones	array	La liste des zones.
	string	La liste des zones.	cn-hangzhou-i
EnableUpgradeLogDisk	boolean	Indique si les spécifications du disque de journalisation peuvent être mises à niveau.	false
Zones	array	L'identifiant de la zone à laquelle l'instance appartient. Pour plus d'informations, consultez DescribeZones pour obtenir la liste des zones.
	string	L'identifiant de la zone à laquelle l'instance appartient. Pour plus d'informations, consultez DescribeZones pour obtenir la liste des zones.	cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j
InstanceRole	string	Le rôle de l'instance.	NORMAL
NodeNum	integer	Le nombre de nœuds du cluster.\nSi le mode de déploiement est n-n-n, le nombre de nœuds est n × 3.	6
ReplicaMode	string	Le nombre de réplicas à fonctionnalités complètes. La valeur de retour peut être 3 ou 2. 3 : trois réplicas à fonctionnalités complètes. 2 : deux réplicas à fonctionnalités complètes. Un déploiement en trois zones prend en charge trois réplicas à fonctionnalités complètes. Un déploiement en deux zones prend en charge deux réplicas à fonctionnalités complètes. Un déploiement en zone unique peut prendre en charge deux ou trois réplicas à fonctionnalités complètes.	2
IsolationOptimization	boolean	Indique si Cgroup est activé.	false
EnableIsolationOptimization	boolean	Indique si l'optimisation de l'isolation peut être activée.	false
InTempCapacityStatus	boolean	L'état de la capacité temporaire.	false
DataDiskAutoScale	boolean	Indique si la mise à l'échelle automatique des données est activée. Remarque Ce paramètre est obsolète.	-
TenantCreatable	object	Les locataires pouvant être créés.
EnableCreateTenant	boolean	Indicates whether the cluster allows tenant creation.	true
DisableCreateTenantReason	string	The reason why the cluster does not allow tenant creation.	CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT
DataDiskAutoScaleConfig	object	La configuration de la mise à l'échelle automatique du disque de données.
AutoScale	boolean	Indicates whether the feature is enabled.	true
Upperbound	integer	The upper limit for scaling.	16
UpperThreshold	integer	The threshold for daily scale-out.	80
UpperMergeThreshold	integer	The threshold for merged scale-out.	90
MaxDiskSize	integer	The maximum disk size.	80000
ScaleStepInNormal	integer	The step size for daily scale-out.	50
ScaleStepInMerge	integer	The step size for merged scale-out.	100
UpperScaleStrategy	string	The scale-out policy. Valid values: RAW and PERCENTAGE.	RAW
UpperScaleStep	string	The scale-out step size.	5
EnableProxyService	boolean	Indique si le service de proxy est activé.	true
ProxyServiceStatus	string	L'état du service de proxy.	ONLINE
ProxyClusterId	string	L'identifiant du cluster proxy. Remarque Ce paramètre est renvoyé uniquement lorsque EnableProxyService est true.	proxy-56****a6tg2o
CpuArchitecture	string	L'architecture CPU du cluster.	X86
ReadOnlyResource	object	Les informations sur les ressources du cluster.
Cpu	object	The CPU resource information of the cluster.
TotalCpu	integer	The total number of CPU cores of the cluster.	14
UsedCpu	integer	The number of used CPU cores of the cluster.	10
UnitCpu	integer	The number of CPU cores of each replica node in the cluster.	10
OriginalTotalCpu	integer	The original number of CPU cores.	14
Memory	object	The memory resource information of the cluster.
TotalMemory	integer	The total memory of the cluster, in GB.	70
UsedMemory	integer	The used memory of the cluster, in GB.	10
UnitMemory	integer	The memory of each replica in the cluster, in GB.	10
OriginalTotalMemory	integer	The original memory size.	72
DiskSize	object	The storage resource information of the cluster.
TotalDiskSize	integer	The total storage space of the cluster, in GB.	200
UsedDiskSize	integer	The used storage space of the cluster, in GB.	100
UnitDiskSize	integer	The storage space of each replica in the cluster, in GB.	200
DataUsedSize	number	The used storage space, in GB.	200
MaxDiskUsedPercent	number	The maximum disk usage, in percentage.	0.14
MaxDiskUsedObServer	array	The maximum disk usage of the server.
	string	The maximum disk usage of the server.	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	The original disk size.	200
MaxDiskSize	number	The maximum disk size that can be created.	80000
UnitCount	integer	The number of resource units in the cluster.	1
LogDiskSize	object	The log disk resource information of the cluster.
TotalDiskSize	integer	The total log disk space of the cluster, in GB.	400
UnitDiskSize	integer	The log storage space of each replica in the cluster, in GB.	200
LogAssignedSize	string	The allocated log storage space.	0.0
MaxLogAssignedObServer	array	The OBServer to which the maximum log space is allocated.
	string	The OBServer to which the maximum log space is allocated.	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	The maximum percentage of allocated log space.	6.68
CapacityUnit	object	The capacity unit.
MaxCapacityUnit	integer	The maximum capacity unit.	4
MinCapacityUnit	integer	The minimum capacity unit.	1
UsedCapacityUnit	string	The used capacity unit.	2
UnitSpec	string	Les spécifications d'unité du service de proxy.	2C4G
SharedUnitNumLimit	integer	La limite supérieure du nombre d'unités pour le service de proxy en mode partagé.	3
ExclusiveUnitNumLimit	integer	La limite supérieure du nombre d'unités pour le service de proxy en mode exclusif.	1
EnableReadOnlyReplica	boolean	Indique si les réplicas en lecture seule sont pris en charge.	true
EnableReadOnlyReplicaManagement	boolean	Indique si vous pouvez acheter des réplicas en lecture seule pour le cluster.	false
PrimaryInstance	string	L'identifiant de l'instance principale.	ob3h8ytroxxxxx
PrimaryRegion	string	La région de l'instance principale.	cn-hangzhou
SpecType	string	Le type de spécification.	dedicatedspec
AllowModifyInternetAddressConnectionLimit	boolean	Indique si le nombre maximum de connexions sur Internet peut être modifié.	false
AllowCreateProxySqlFirewallRule	boolean	Indique si le pare-feu SQL ODP est autorisé.	false
Iops	integer		10000

Exemples

JSON format

{
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C",
  "Instance": {
    "InstanceId": "ob317v4uif****",
    "InstanceName": "ob4test",
    "InstanceClass": "14C70G",
    "Series": "Normal",
    "PayType": "PREPAY",
    "CreateTime": "2021-10-19T07:13:41Z",
    "ExpireTime": "2021-10-17T16:00:00Z",
    "Version": "2.2.77",
    "DeployType": "multiple",
    "DeployMode": "1-1-1",
    "DiskType": "cloud_essd_pl1",
    "MaintainTime": "19:00Z-20:00Z",
    "DataMergeTime": "02:00",
    "AutoRenewal": true,
    "IsTrustEcs": true,
    "Status": "ONLINE",
    "Resource": {
      "Cpu": {
        "TotalCpu": 14,
        "UsedCpu": 10,
        "UnitCpu": 10,
        "OriginalTotalCpu": 14
      },
      "Memory": {
        "TotalMemory": 70,
        "UsedMemory": 10,
        "UnitMemory": 10,
        "OriginalTotalMemory": 72
      },
      "DiskSize": {
        "TotalDiskSize": 200,
        "UsedDiskSize": 100,
        "UnitDiskSize": 200,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ],
        "OriginalTotalDiskSize": 200,
        "MaxDiskSize": 80000
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200,
        "LogAssignedSize": "0.0",
        "MaxLogAssignedObServer": [
          "[\"i-bp1g****\",\"i-bp11****\",\"i-bp19****\"]"
        ],
        "MaxLogAssignedPercent": "6.68",
        "OriginalTotalDiskSize": 200
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 4,
        "MinCapacityUnit": 1,
        "UsedCapacityUnit": "2"
      }
    },
    "AutoUpgradeObVersion": true,
    "ObRpmVersion": "2.2.77-20210526202046",
    "IsLatestObVersion": true,
    "AvailableZones": [
      "cn-hangzhou-i"
    ],
    "EnableUpgradeLogDisk": false,
    "Zones": [
      "cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j"
    ],
    "InstanceRole": "NORMAL",
    "NodeNum": 6,
    "ReplicaMode": "2",
    "IsolationOptimization": false,
    "EnableIsolationOptimization": false,
    "InTempCapacityStatus": false,
    "DataDiskAutoScale": true,
    "TenantCreatable": {
      "EnableCreateTenant": true,
      "DisableCreateTenantReason": "CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT"
    },
    "DataDiskAutoScaleConfig": {
      "AutoScale": true,
      "Upperbound": 16,
      "UpperThreshold": 80,
      "UpperMergeThreshold": 90,
      "MaxDiskSize": 80000,
      "ScaleStepInNormal": 50,
      "ScaleStepInMerge": 100,
      "UpperScaleStrategy": "RAW",
      "UpperScaleStep": "5"
    },
    "EnableProxyService": true,
    "ProxyServiceStatus": "ONLINE",
    "ProxyClusterId": "proxy-56****a6tg2o",
    "CpuArchitecture": "X86",
    "ReadOnlyResource": {
      "Cpu": {
        "TotalCpu": 14,
        "UsedCpu": 10,
        "UnitCpu": 10,
        "OriginalTotalCpu": 14
      },
      "Memory": {
        "TotalMemory": 70,
        "UsedMemory": 10,
        "UnitMemory": 10,
        "OriginalTotalMemory": 72
      },
      "DiskSize": {
        "TotalDiskSize": 200,
        "UsedDiskSize": 100,
        "UnitDiskSize": 200,
        "DataUsedSize": 200,
        "MaxDiskUsedPercent": 0.14,
        "MaxDiskUsedObServer": [
          "i-bp1fhj23fs32dfbg4****"
        ],
        "OriginalTotalDiskSize": 200,
        "MaxDiskSize": 80000
      },
      "UnitCount": 1,
      "LogDiskSize": {
        "TotalDiskSize": 400,
        "UnitDiskSize": 200,
        "LogAssignedSize": "0.0",
        "MaxLogAssignedObServer": [
          "[\"i-bp1g****\",\"i-bp11****\",\"i-bp19****\"]"
        ],
        "MaxLogAssignedPercent": "6.68"
      },
      "CapacityUnit": {
        "MaxCapacityUnit": 4,
        "MinCapacityUnit": 1,
        "UsedCapacityUnit": "2"
      }
    },
    "UnitSpec": "2C4G",
    "SharedUnitNumLimit": 3,
    "ExclusiveUnitNumLimit": 1,
    "EnableReadOnlyReplica": true,
    "EnableReadOnlyReplicaManagement": false,
    "PrimaryInstance": "ob3h8ytroxxxxx",
    "PrimaryRegion": "cn-hangzhou",
    "SpecType": "dedicatedspec",
    "AllowModifyInternetAddressConnectionLimit": false,
    "AllowCreateProxySqlFirewallRule": false,
    "Iops": 10000
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.