DescribeInstance - ApsaraDB for HBase - Centro de documentación de Alibaba Cloud

Consulta los detalles de una instancia específica de ApsaraDB for HBase, incluido su estado, edición, configuración de nodos, ajustes de red, método de facturación y estado de las funciones.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	DescribeInstance	La operación que se va a realizar. Establezca el valor en DescribeInstance.
ClusterId	String	Sí	ld-bp150tns0sjxs****	El ID de la instancia que se va a consultar.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66	El ID de la solicitud.
ClusterId	String	ld-bp150tns0sjxs****	El ID de la instancia.
InstanceId	String	ld-bp150tns0sjxs****	El ID de la instancia.
ClusterName	String	testhbase	El nombre de la instancia.
InstanceName	String	testhbase	El nombre de la instancia.
ClusterType	String	cluster	El tipo de instancia. Valores válidos: cluster (instancia de clúster), single (instancia independiente).
Engine	String	hbaseue	La edición de la instancia. Valores válidos: hbase (ApsaraDB for HBase Standard Edition o Standalone Edition), hbaseue (ApsaraDB for HBase Performance-enhanced Edition), serverlesshbase (ApsaraDB for HBase Serverless Edition), bds (edición BDS que utiliza Lindorm Tunnel Service (LTS)).
Status	String	ACTIVATION	El estado de la instancia. Valores válidos: CREATING (la instancia se está creando), ACTIVATION (la instancia está en ejecución), DELETING (la instancia se está eliminando), RESTARTING (la instancia se está reiniciando), MINOR_VERSION_TRANSING (la versión secundaria se está actualizando).
RegionId	String	cn-hangzhou	El ID de la región donde se despliega la instancia.
ZoneId	String	cn-hangzhou-f	El ID de la zona donde se despliega la instancia.
PayType	String	Prepaid	El método de facturación. Valores válidos: Prepaid (suscripción), Postpaid (pay-as-you-go).
CreatedTime	String	2021-07-19T11:23:22	La hora en que se creó la instancia.
CreatedTimeUTC	String	2021-07-19T03:23:22Z	La hora en que se creó la instancia. La hora sigue el estándar ISO 8601 en formato yyyy-MM-ddTHH:mm:ssZ y se expresa en UTC.
ExpireTime	String	2022-02-24T00:00:00	La hora de vencimiento de la instancia.
ExpireTimeUTC	String	2022-02-23T16:00:00Z	La hora de vencimiento de la instancia. La hora sigue el estándar ISO 8601 en formato yyyy-MM-ddTHH:mm:ssZ y se expresa en UTC.
MajorVersion	String	2.0	La versión principal de la instancia.
MinorVersion	String	2.2.9.1	La versión secundaria de la instancia.
IsLatestVersion	Boolean	true	Indica si la instancia ejecuta la versión más reciente. Valores válidos: true, false.
IsHa	Boolean	true	Indica si la instancia cuenta con alta disponibilidad. Valores válidos: true (alta disponibilidad), false (sin alta disponibilidad). Nota De forma predeterminada, una instancia de clúster tiene dos nodos maestros para garantizar la alta disponibilidad. Una instancia independiente tiene un solo nodo y su capacidad total de almacenamiento equivale a la capacidad del disco de dicho nodo.
IsMultiModel	Boolean	true	Indica si la instancia admite varios modelos de datos. Valores válidos: true (la instancia es de clúster y admite varios modelos de datos), false (no admite varios modelos de datos).
NetworkType	String	VPC	El tipo de red. Valores válidos: VPC (virtual private cloud (VPC)), CLASSIC (red clásica). Si el valor es VPC, también se devuelven los parámetros VpcId y VswitchId.
VpcId	String	vpc-bp15s22y1a7sff5gj****	El ID de la VPC. Este parámetro se devuelve únicamente cuando NetworkType es VPC.
VswitchId	String	vsw-bp1foll427ze3d4ps****	El ID del vSwitch. Este parámetro se devuelve únicamente cuando NetworkType es VPC.
MasterNodeCount	Integer	2	La categoría del nodo maestro. Valores válidos: 0 (nodo independiente), 2 (nodo de clúster).
MasterInstanceType	String	hbase.sn2.large	El tipo de instancia de los nodos maestros.
MasterDiskSize	Integer	0	La capacidad del disco de cada nodo maestro, en GB.
MasterDiskType	String	cloud_efficiency	El tipo de disco de los nodos maestros. Valores válidos: cloud_efficiency (disco ultra), cloud_ssd (SSD estándar). Nota Este parámetro se devuelve únicamente para instancias independientes.
CoreNodeCount	Integer	2	El número de nodos principales.
CoreInstanceType	String	hbase.sn2.2xlarge	El tipo de instancia de los nodos principales.
CoreDiskCount	String	4	El número de discos en cada nodo principal.
CoreDiskSize	Integer	100	La capacidad del disco de cada nodo principal, en GB.
CoreDiskType	String	cloud_ssd	El tipo de disco de los nodos principales. Valores válidos: cloud_efficiency (disco ultra), cloud_ssd (SSD estándar), local_hdd (HDD local), local__ssd (SSD local).
BackupStatus	String	open	El estado de la función de copia de seguridad. Valores válidos: open (habilitado), close (deshabilitado).
ColdStorageStatus	String	open	El estado de la función de almacenamiento en frío. Valores válidos: open (habilitado), close (deshabilitado).
ColdStorageSize	Integer	800	La capacidad de almacenamiento en frío, en GB.
MaintainStartTime	String	18:00Z	La hora de inicio de la ventana de mantenimiento, en UTC.
MaintainEndTime	String	22:00Z	La hora de finalización de la ventana de mantenimiento, en UTC.
ConfirmMaintainTime	String	true	Indica si se ha confirmado la ventana de mantenimiento. Valores válidos: true (confirmado), false (no confirmado). Nota El cuadro de diálogo Confirm Maintenance Window aparece únicamente la primera vez que abre la página Basic Information de su instancia.
IsDeletionProtection	Boolean	false	Indica si la protección contra eliminación está habilitada. Valores válidos: true (habilitado), false (deshabilitado).
EncryptionType	String	NoEncryption	El tipo de cifrado. Valores válidos: NoEncryption (el cifrado de disco no está habilitado), CloudDisk (el cifrado de disco está habilitado; también se devuelve el parámetro EncryptionKey). Nota El cifrado de disco no se puede deshabilitar una vez habilitado.
EncryptionKey	String	0d2470df-da7b-4786-b981-9a164dae****	La clave criptográfica. Este parámetro se devuelve únicamente cuando EncryptionType es CloudDisk.
AutoRenewal	Boolean	false	Indica si la renovación automática está habilitada. Valores válidos: true (habilitado), false (deshabilitado). Nota Este parámetro no se devuelve para instancias pay-as-you-go.
Duration	Integer	12	El ciclo de renovación automática. Para suscripciones mensuales, el ciclo es de 1 mes. Para suscripciones anuales, el ciclo es de 12 meses. Nota Este parámetro no se devuelve para instancias pay-as-you-go.
NeedUpgrade	Boolean	false	Indica si los componentes de la instancia se pueden actualizar. Valores válidos: true (actualizable), false (no actualizable).
NeedUpgradeComps	List	[lindorm, hdfs]	Los nombres de los componentes que se pueden actualizar. Este parámetro se devuelve únicamente cuando NeedUpgrade es true.
TaskProgress	String	25.00	El progreso de la tarea que se ejecuta en la instancia, expresado como porcentaje. Las tareas incluyen cambios de especificaciones, escalado horizontal o vertical de nodos, reinicio de la instancia y actualización de la versión secundaria.
ResourceGroupId	String	rg-acfmyiu4ekp****	El ID del resource group que contiene la instancia.
ModuleId	Integer	0	El ID del módulo.
ModuleStackVersion	String	phoenxi:4.0	La versión de la pila del módulo.
ParentId	String	ld-uf699153o1m2l****	El ID de la instancia principal.
Tags	Array of Tag		Las etiquetas asociadas a la instancia.
Tag
Key	String	test_key	La clave de la etiqueta.
Value	String	test_value	El valor de la etiqueta.

Ejemplos

Solicitud de ejemplo

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

Respuestas de éxito de ejemplo

Formato 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>

Formato 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
}

Códigos de error

Para consultar una lista de códigos de error, visite el API Error Center.