DescribeInstance - ApsaraDB for HBase - Centre de documentation Alibaba Cloud

Récupère les détails d'une instance ApsaraDB for HBase spécifiée, notamment son état, son édition, la configuration des nœuds, les paramètres réseau, la méthode de facturation et l'état des fonctionnalités.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeInstance	Opération à effectuer. Définissez la valeur sur DescribeInstance.
ClusterId	String	Oui	ld-bp150tns0sjxs****	ID de l'instance à interroger.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66	ID de la requête.
ClusterId	String	ld-bp150tns0sjxs****	ID de l'instance.
InstanceId	String	ld-bp150tns0sjxs****	ID de l'instance.
ClusterName	String	testhbase	Nom de l'instance.
InstanceName	String	testhbase	Nom de l'instance.
ClusterType	String	cluster	Type d'instance. Valeurs valides : cluster (instance en cluster), single (instance autonome).
Engine	String	hbaseue	Édition de l'instance. Valeurs valides : hbase (ApsaraDB for HBase Édition standard ou Édition autonome), hbaseue (ApsaraDB for HBase Édition améliorée pour les performances), serverlesshbase (ApsaraDB for HBase Édition serverless), bds (Édition BDS utilisant Lindorm Tunnel Service (LTS)).
Status	String	ACTIVATION	État de l'instance. Valeurs valides : CREATING (création de l'instance en cours), ACTIVATION (instance en cours d'exécution), DELETING (suppression de l'instance en cours), RESTARTING (redémarrage de l'instance en cours), MINOR_VERSION_TRANSING (mise à jour de la version mineure en cours).
RegionId	String	cn-hangzhou	ID de la région où l'instance est déployée.
ZoneId	String	cn-hangzhou-f	ID de la zone où l'instance est déployée.
PayType	String	Prepaid	Méthode de facturation. Valeurs valides : Prepaid (abonnement), Postpaid (paiement à l'utilisation).
CreatedTime	String	2021-07-19T11:23:22	Date et heure de création de l'instance.
CreatedTimeUTC	String	2021-07-19T03:23:22Z	Date et heure de création de l'instance. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ et est exprimée en UTC.
ExpireTime	String	2022-02-24T00:00:00	Date et heure d'expiration de l'instance.
ExpireTimeUTC	String	2022-02-23T16:00:00Z	Date et heure d'expiration de l'instance. L'heure suit la norme ISO 8601 au format yyyy-MM-ddTHH:mm:ssZ et est exprimée en UTC.
MajorVersion	String	2.0	Version majeure de l'instance.
MinorVersion	String	2.2.9.1	Version mineure de l'instance.
IsLatestVersion	Boolean	true	Indique si l'instance exécute la dernière version. Valeurs valides : true, false.
IsHa	Boolean	true	Indique si l'instance offre une haute disponibilité. Valeurs valides : true (haute disponibilité), false (pas de haute disponibilité). Remarque Par défaut, une instance en cluster dispose de deux nœuds maîtres pour garantir la haute disponibilité. Une instance autonome ne comporte qu'un seul nœud et sa capacité de stockage totale équivaut à la capacité du disque de ce nœud.
IsMultiModel	Boolean	true	Indique si l'instance prend en charge plusieurs modèles de données. Valeurs valides : true (l'instance est une instance en cluster qui prend en charge plusieurs modèles de données), false (ne prend pas en charge plusieurs modèles de données).
NetworkType	String	VPC	Type de réseau. Valeurs valides : VPC (réseau privé virtuel (VPC)), CLASSIC (réseau classique). Si la valeur est VPC, les paramètres VpcId et VswitchId sont également renvoyés.
VpcId	String	vpc-bp15s22y1a7sff5gj****	ID du VPC. Ce paramètre n'est renvoyé que lorsque NetworkType a la valeur VPC.
VswitchId	String	vsw-bp1foll427ze3d4ps****	ID du vSwitch. Ce paramètre n'est renvoyé que lorsque NetworkType a la valeur VPC.
MasterNodeCount	Integer	2	Catégorie des nœuds maîtres. Valeurs valides : 0 (nœud autonome), 2 (nœud en cluster).
MasterInstanceType	String	hbase.sn2.large	Type d'instance des nœuds maîtres.
MasterDiskSize	Integer	0	Capacité du disque de chaque nœud maître, en Go.
MasterDiskType	String	cloud_efficiency	Type de disque des nœuds maîtres. Valeurs valides : cloud_efficiency (disque ultra), cloud_ssd (SSD standard). Remarque Ce paramètre n'est renvoyé que pour les instances autonomes.
CoreNodeCount	Integer	2	Nombre de nœuds principaux.
CoreInstanceType	String	hbase.sn2.2xlarge	Type d'instance des nœuds principaux.
CoreDiskCount	String	4	Nombre de disques sur chaque nœud principal.
CoreDiskSize	Integer	100	Capacité du disque de chaque nœud principal, en Go.
CoreDiskType	String	cloud_ssd	Type de disque des nœuds principaux. Valeurs valides : cloud_efficiency (disque ultra), cloud_ssd (SSD standard), local_hdd (HDD local), local__ssd (SSD local).
BackupStatus	String	open	État de la fonctionnalité de sauvegarde. Valeurs valides : open (activée), close (désactivée).
ColdStorageStatus	String	open	État de la fonctionnalité de stockage froid. Valeurs valides : open (activée), close (désactivée).
ColdStorageSize	Integer	800	Capacité du stockage froid, en Go.
MaintainStartTime	String	18:00Z	Heure de début de la fenêtre de maintenance, en UTC.
MaintainEndTime	String	22:00Z	Heure de fin de la fenêtre de maintenance, en UTC.
ConfirmMaintainTime	String	true	Indique si la fenêtre de maintenance a été confirmée. Valeurs valides : true (confirmée), false (non confirmée). Remarque La boîte de dialogue Confirm Maintenance Window n'apparaît que la première fois que vous ouvrez la page Basic Information de votre instance.
IsDeletionProtection	Boolean	false	Indique si la protection contre la suppression est activée. Valeurs valides : true (activée), false (désactivée).
EncryptionType	String	NoEncryption	Type de chiffrement. Valeurs valides : NoEncryption (le chiffrement des disques n'est pas activé), CloudDisk (le chiffrement des disques est activé ; le paramètre EncryptionKey est également renvoyé). Remarque Le chiffrement des disques ne peut pas être désactivé une fois activé.
EncryptionKey	String	0d2470df-da7b-4786-b981-9a164dae****	Clé cryptographique. Ce paramètre n'est renvoyé que lorsque EncryptionType a la valeur CloudDisk.
AutoRenewal	Boolean	false	Indique si le renouvellement automatique est activé. Valeurs valides : true (activé), false (désactivé). Remarque Ce paramètre n'est pas renvoyé pour les instances avec paiement à l'utilisation.
Duration	Integer	12	Cycle de renouvellement automatique. Pour les abonnements mensuels, le cycle est de 1 mois. Pour les abonnements annuels, le cycle est de 12 mois. Remarque Ce paramètre n'est pas renvoyé pour les instances avec paiement à l'utilisation.
NeedUpgrade	Boolean	false	Indique si les composants de l'instance peuvent être mis à niveau. Valeurs valides : true (mise à niveau possible), false (mise à niveau impossible).
NeedUpgradeComps	List	[lindorm, hdfs]	Noms des composants pouvant être mis à niveau. Ce paramètre n'est renvoyé que lorsque NeedUpgrade a la valeur true.
TaskProgress	String	25.00	Progression de la tâche en cours d'exécution sur l'instance, exprimée en pourcentage. Les tâches incluent la modification des spécifications, la mise à l'échelle horizontale des nœuds, le redémarrage de l'instance et la mise à jour de la version mineure.
ResourceGroupId	String	rg-acfmyiu4ekp****	ID du groupe de ressources contenant l'instance.
ModuleId	Integer	0	ID du module.
ModuleStackVersion	String	phoenxi:4.0	Version de la pile de modules.
ParentId	String	ld-uf699153o1m2l****	ID de l'instance parente.
Tags	Array of Tag		Tags associés à l'instance.
Tag
Key	String	test_key	Clé du tag.
Value	String	test_value	Valeur du tag.

Exemples

Exemple de requête

http(s)://hbase.aliyuncs.com/?Action=DescribeInstance
&ClusterId=ld-bp150tns0sjxs****
&<Common request parameters>

Exemple de réponses réussies

Format XML

<DescribeInstanceResponse>
  <CreatedTime>2021-07-19T11:23:22</CreatedTime>
  <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
  <NeedUpgrade>false</NeedUpgrade>
  <ModuleId>0</ModuleId>
  <Engine>hbaseue</Engine>
  <NeedUpgradeComps>
</NeedUpgradeComps>
  <Tags>
</Tags>
  <Status>ACTIVATION</Status>
  <ColdStorageSize>800</ColdStorageSize>
  <EncryptionType>NoEncryption</EncryptionType>
  <MasterDiskSize>0</MasterDiskSize>
  <ExpireTimeUTC>2022-02-23T16:00:00Z</ExpireTimeUTC>
  <RequestId>3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66</RequestId>
  <InstanceId>ld-bp150tns0sjxs****</InstanceId>
  <PayType>Prepaid</PayType>
  <VswitchId>vsw-bp1foll427ze3d4ps****</VswitchId>
  <InstanceName>testhbase</InstanceName>
  <MasterNodeCount>2</MasterNodeCount>
  <VpcId>vpc-bp15s22y1a7sff5gj****</VpcId>
  <AutoRenewal>false</AutoRenewal>
  <CoreDiskType>cloud_ssd</CoreDiskType>
  <ExpireTime>2022-02-24T00:00:00</ExpireTime>
  <BackupStatus>open</BackupStatus>
  <IsHa>true</IsHa>
  <TaskProgress>25.00</TaskProgress>
  <MasterInstanceType>hbase.sn1.2xlarge</MasterInstanceType>
  <IsDeletionProtection>false</IsDeletionProtection>
  <IsLatestVersion>true</IsLatestVersion>
  <MaintainEndTime>22:00Z</MaintainEndTime>
  <NetworkType>VPC</NetworkType>
  <CoreInstanceType>hbase.sn2.2xlarge</CoreInstanceType>
  <ClusterName>testhbase</ClusterName>
  <MasterDiskType></MasterDiskType>
  <MaintainStartTime>18:00Z</MaintainStartTime>
  <MajorVersion>2.0</MajorVersion>
  <CoreDiskCount>4</CoreDiskCount>
  <ZoneId>cn-hangzhou-f</ZoneId>
  <CoreNodeCount>2</CoreNodeCount>
  <ClusterId>ld-bp150tns0sjxs****</ClusterId>
  <ColdStorageStatus>open</ColdStorageStatus>
  <MinorVersion>2.2.9.1</MinorVersion>
  <CreatedTimeUTC>2021-07-19T03:23:22Z</CreatedTimeUTC>
  <IsMultiModel>true</IsMultiModel>
  <ClusterType>cluster</ClusterType>
  <RegionId>cn-hangzhou</RegionId>
  <CoreDiskSize>100</CoreDiskSize>
  <ConfirmMaintainTime>true</ConfirmMaintainTime>
</DescribeInstanceResponse>

Format JSON

{
    "CreatedTime": "2021-07-19T11:23:22",
    "ResourceGroupId": "rg-acfmyiu4ekp****",
    "NeedUpgrade": false,
    "ModuleId": 0,
    "Engine": "hbaseue",
    "NeedUpgradeComps": {
        "Comps": []
    },
    "Tags": {
        "Tag": []
    },
    "Status": "ACTIVATION",
    "ColdStorageSize": 800,
    "EncryptionType": "NoEncryption",
    "MasterDiskSize": 0,
    "ExpireTimeUTC": "2022-02-23T16:00:00Z",
    "RequestId": "3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66",
    "InstanceId": "ld-bp150tns0sjxs****",
    "PayType": "Prepaid",
    "VswitchId": "vsw-bp1foll427ze3d4ps****",
    "InstanceName": "testhbase",
    "MasterNodeCount": 2,
    "VpcId": "vpc-bp15s22y1a7sff5gj****",
    "AutoRenewal": false,
    "CoreDiskType": "cloud_ssd",
    "ExpireTime": "2022-02-24T00:00:00",
    "BackupStatus": "open",
    "IsHa": true,
    "TaskProgress": "25.00",
    "MasterInstanceType": "hbase.sn1.2xlarge",
    "IsDeletionProtection": false,
    "IsLatestVersion": true,
    "MaintainEndTime": "22:00Z",
    "NetworkType": "VPC",
    "CoreInstanceType": "hbase.sn2.2xlarge",
    "ClusterName": "testhbase",
    "MasterDiskType": "",
    "MaintainStartTime": "18:00Z",
    "MajorVersion": "2.0",
    "CoreDiskCount": 4,
    "ZoneId": "cn-hangzhou-f",
    "CoreNodeCount": 2,
    "ClusterId": "ld-bp150tns0sjxs****",
    "ColdStorageStatus": "open",
    "MinorVersion": "2.2.9.1",
    "CreatedTimeUTC": "2021-07-19T03:23:22Z",
    "IsMultiModel": true,
    "ClusterType": "cluster",
    "RegionId": "cn-hangzhou",
    "ConfirmMaintainTime": true,
    "CoreDiskSize": 100
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez le Centre d'erreurs API.