DescribeInstance - ApsaraDB for OceanBase (Deprecated) - Centro de documentación de Alibaba Cloud

Consulta los detalles de un clúster de OceanBase.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

oceanbase:DescribeInstance

get

*Instance

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

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID del clúster de OceanBase.	ob317v4uif****
PageNumber	integer	No	Número de página para la consulta paginada. Valor inicial: 1. Valor predeterminado: 1.	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El resultado de la solicitud.
RequestId	string	El ID de la solicitud.	EE205C00-30E4-**-**-87E3A8A2AA0C
Instance	object	La información del clúster de OceanBase.
InstanceId	string	El ID del clúster de OceanBase.	ob317v4uif****
InstanceName	string	El nombre del clúster de OceanBase.	ob4test
InstanceClass	string	Las especificaciones del clúster. Se admiten los siguientes planes: 4C16GB: 4 núcleos, 16 GB. 8C32GB: 8 núcleos, 32 GB. 14C70GB: 14 núcleos, 70 GB. 24C120GB: 24 núcleos, 120 GB. 30C180GB: 30 núcleos, 180 GB. 62C400GB: 62 núcleos, 400 GB. 104C600GB: 104 núcleos, 600 GB. 16C70GB: 16 núcleos, 70 GB. 32C160GB: 32 núcleos, 160 GB. 64C380GB: 64 núcleos, 380 GB. 20C32GB: 20 núcleos, 32 GB. 40C64GB: 40 núcleos, 64 GB. 16C32GB: 16 núcleos, 32 GB. 32C70GB: 32 núcleos, 70 GB. 64C180GB: 64 núcleos, 180 GB. 32C180GB: 32 núcleos, 180 GB. 64C400GB: 64 núcleos, 400 GB.	14C70G
Series	string	La serie de la instancia. normal (predeterminado): Standard Cluster Edition (disco en la nube). normal_ssd: Standard Cluster Edition (disco local). history: Archive Database Cluster Edition. normal_kv: Clúster OBKV. normal_hg: Clúster de aplicaciones innovadoras.	Normal
PayType	string	El método de facturación del clúster de OceanBase. PREPAY: suscripción. POSTPAY: pago por uso.	PREPAY
CreateTime	string	La hora en que se creó el clúster. La hora está en formato UTC.	2021-10-19T07:13:41Z
ExpireTime	string	La hora de caducidad del clúster. La hora está en formato UTC.	2021-10-17T16:00:00Z
Version	string	La versión de OBServer.	2.2.77
DeployType	string	El tipo de despliegue del clúster. multiple: múltiples centros de datos. single: centro de datos único. dual: doble centro de datos.	multiple
DeployMode	string	El modo de replicación de datos del clúster. n para un solo centro de datos. n-n para dos centros de datos. n-n-n para múltiples centros de datos. Nota En este modo, n indica el número de nodos OBServer en cada centro de datos.	1-1-1
DiskType	string	La clase de almacenamiento del clúster. El valor predeterminado es cloud_essd_pl1, que indica un disco en la nube ESSD.	cloud_essd_pl1
MaintainTime	string	La ventana de mantenimiento diario del clúster. La hora está en formato UTC.	19:00Z-20:00Z
DataMergeTime	string	La hora de fusión de datos del clúster.	02:00
AutoRenewal	boolean	Indica si la renovación automática está habilitada. Este parámetro solo es válido para clústeres de suscripción.	true
IsTrustEcs	boolean	Indica si se utiliza una instancia ECS de confianza.	true
Status	string	El estado del clúster. PENDING_CREATE: La instancia se está creando. ONLINE: La instancia está en ejecución. TENANT_CREATING: Se está creando un inquilino. TENANT_SPEC_MODIFYING: Se están modificando las especificaciones del inquilino. EXPANDING: El número de nodos está aumentando. REDUCING: El número de nodos está disminuyendo. SPEC_UPGRADING: Las especificaciones de la instancia se están actualizando. DISK_UPGRADING: La capacidad de almacenamiento está aumentando. WHITE_LIST_MODIFYING: La lista blanca se está modificando. PARAMETER_MODIFYING: Los parámetros se están modificando. SSL_MODIFYING: El certificado SSL se está cambiando. PREPAID_EXPIRE_CLOSED: El clúster de suscripción está suspendido debido a un pago vencido. ARREARS_CLOSED: El clúster de pago por uso está suspendido debido a un pago vencido. PENDING_DELETE: La instancia se está eliminando. Por lo general, el clúster se encuentra en estado ONLINE.	ONLINE
Resource	object	La información de recursos del clúster.
Cpu	object	La información de recursos de CPU del clúster.
TotalCpu	integer	El número total de núcleos de CPU del clúster.	14
UsedCpu	integer	El número de núcleos de CPU utilizados del clúster.	10
UnitCpu	integer	El número de núcleos de CPU de cada nodo de réplica en el clúster.	10
OriginalTotalCpu	integer	El número original de núcleos de CPU.	14
Memory	object	La información de recursos de memoria del clúster.
TotalMemory	integer	La memoria total del clúster, en GB.	70
UsedMemory	integer	La memoria utilizada del clúster, en GB.	10
UnitMemory	integer	La memoria de cada réplica en el clúster, en GB.	10
OriginalTotalMemory	integer	El tamaño original de memoria.	72
DiskSize	object	La información de recursos de almacenamiento del clúster.
TotalDiskSize	integer	El espacio de almacenamiento total del clúster, en GB.	200
UsedDiskSize	integer	El espacio de almacenamiento utilizado del clúster, en GB.	100
UnitDiskSize	integer	El espacio de almacenamiento de cada réplica en el clúster, en GB.	200
DataUsedSize	number	El tamaño del disco de datos, en GB.	200
MaxDiskUsedPercent	number	El uso máximo de disco, en porcentaje.	0.14
MaxDiskUsedObServer	array	El uso máximo de disco del servidor.
	string	La lista de nodos OBServer con el mayor uso de disco de datos.	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	El tamaño original del disco.	200
MaxDiskSize	number	El tamaño máximo de disco que se puede crear.	80000
UnitCount	integer	El número de unidades de recursos en el clúster.	1
LogDiskSize	object	La información de recursos del disco de registros del clúster.
TotalDiskSize	integer	El espacio total del disco de registros del clúster, en GB.	400
UnitDiskSize	integer	El espacio de almacenamiento de registros de cada réplica en el clúster, en GB.	200
LogAssignedSize	string	El espacio de almacenamiento de registros asignado, en GB.	0.0
MaxLogAssignedObServer	array	La información sobre el espacio de almacenamiento máximo asignado al servidor.
	string	La lista de nodos OBServer con el mayor uso de disco de registros.	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	El porcentaje máximo de espacio de almacenamiento de registros asignado.	6.68
OriginalTotalDiskSize	integer	El tamaño original del disco de registros.	200
CapacityUnit	object	La unidad de capacidad.
MaxCapacityUnit	integer	La unidad de capacidad máxima.	4
MinCapacityUnit	integer	La unidad de capacidad mínima.	1
UsedCapacityUnit	string	La unidad de capacidad utilizada.	2
AutoUpgradeObVersion	boolean	Indica si se debe actualizar automáticamente la versión de OBServer.	true
ObRpmVersion	string	La información detallada de la versión de OBServer.	2.2.77-20210526202046
IsLatestObVersion	boolean	Indica si OBServer tiene la versión más reciente.	true
AvailableZones	array	La lista de zonas.
	string	La lista de zonas.	cn-hangzhou-i
EnableUpgradeLogDisk	boolean	Indica si se pueden actualizar las especificaciones del disco de registros.	false
Zones	array	El ID de la zona a la que pertenece la instancia. Para obtener más información, consulte DescribeZones para obtener la lista de zonas.
	string	El ID de la zona a la que pertenece la instancia. Para obtener más información, consulte DescribeZones para obtener la lista de zonas.	cn-hangzhou-h,cn-hangzhou-i,cn-hangzhou-j
InstanceRole	string	El rol de la instancia.	NORMAL
NodeNum	integer	El número de nodos en el clúster. Si el modo de despliegue es n-n-n, el número de nodos es n × 3.	6
ReplicaMode	string	El número de réplicas con todas las funciones. El valor devuelto puede ser 3 o 2. 3: tres réplicas con todas las funciones. 2: dos réplicas con todas las funciones. Un despliegue en tres zonas admite tres réplicas con todas las funciones. Un despliegue en dos zonas admite dos réplicas con todas las funciones. Un despliegue en una sola zona puede admitir dos o tres réplicas con todas las funciones.	2
IsolationOptimization	boolean	Indica si Cgroup está habilitado.	false
EnableIsolationOptimization	boolean	Indica si se puede habilitar la optimización de aislamiento.	false
InTempCapacityStatus	boolean	El estado de la capacidad temporal.	false
DataDiskAutoScale	boolean	Indica si el ajuste automático de datos está habilitado. Nota Este parámetro está obsoleto.	-
TenantCreatable	object	Los inquilinos que se pueden crear.
EnableCreateTenant	boolean	Indica si el clúster permite la creación de inquilinos.	true
DisableCreateTenantReason	string	El motivo por el cual el clúster no permite la creación de inquilinos.	CPU_NOT_ENOUGH、 MEMORY_NOT_ENOUGH、TENANT_COUNT_EXCEEDS_LIMIT
DataDiskAutoScaleConfig	object	La configuración del ajuste automático del disco de datos.
AutoScale	boolean	Indica si la función está habilitada.	true
Upperbound	integer	El límite superior para la expansión.	16
UpperThreshold	integer	El umbral para la expansión diaria.	80
UpperMergeThreshold	integer	El umbral para la expansión por fusión.	90
MaxDiskSize	integer	El tamaño máximo del disco.	80000
ScaleStepInNormal	integer	El tamaño del incremento para la expansión diaria.	50
ScaleStepInMerge	integer	El tamaño del incremento para la expansión por fusión.	100
UpperScaleStrategy	string	La política de expansión. Valores válidos: RAW y PERCENTAGE.	RAW
UpperScaleStep	string	El tamaño del incremento de expansión.	5
EnableProxyService	boolean	Indica si el servicio de proxy está habilitado. true false	true
ProxyServiceStatus	string	El estado del servicio de proxy.	ONLINE
ProxyClusterId	string	El ID del clúster de proxy. Nota Este parámetro se devuelve solo cuando EnableProxyService es true.	proxy-56****a6tg2o
CpuArchitecture	string	La arquitectura de CPU del clúster.	X86
ReadOnlyResource	object	La información de recursos del clúster.
Cpu	object	La información de recursos de CPU del clúster.
TotalCpu	integer	El número total de núcleos de CPU del clúster.	14
UsedCpu	integer	El número de núcleos de CPU utilizados del clúster.	10
UnitCpu	integer	El número de núcleos de CPU de cada nodo de réplica en el clúster.	10
OriginalTotalCpu	integer	El número original de núcleos de CPU.	14
Memory	object	La información de recursos de memoria del clúster.
TotalMemory	integer	La memoria total del clúster, en GB.	70
UsedMemory	integer	La memoria utilizada del clúster, en GB.	10
UnitMemory	integer	La memoria de cada réplica en el clúster, en GB.	10
OriginalTotalMemory	integer	El tamaño original de memoria.	72
DiskSize	object	La información de recursos de almacenamiento del clúster.
TotalDiskSize	integer	El espacio de almacenamiento total del clúster, en GB.	200
UsedDiskSize	integer	El espacio de almacenamiento utilizado del clúster, en GB.	100
UnitDiskSize	integer	El espacio de almacenamiento de cada réplica en el clúster, en GB.	200
DataUsedSize	number	El espacio de almacenamiento utilizado, en GB.	200
MaxDiskUsedPercent	number	El uso máximo de disco, en porcentaje.	0.14
MaxDiskUsedObServer	array	El uso máximo de disco del servidor.
	string	El uso máximo de disco del servidor.	i-bp1fhj23fs32dfbg4****
OriginalTotalDiskSize	integer	El tamaño original del disco.	200
MaxDiskSize	number	El tamaño máximo de disco que se puede crear.	80000
UnitCount	integer	El número de unidades de recursos en el clúster.	1
LogDiskSize	object	La información de recursos del disco de registros del clúster.
TotalDiskSize	integer	El espacio total del disco de registros del clúster, en GB.	400
UnitDiskSize	integer	El espacio de almacenamiento de registros de cada réplica en el clúster, en GB.	200
LogAssignedSize	string	El espacio de almacenamiento de registros asignado.	0.0
MaxLogAssignedObServer	array	El OBServer al que se le ha asignado el máximo espacio de registros.
	string	El OBServer al que se le ha asignado el máximo espacio de registros.	["i-bp1g**","i-bp11","i-bp19**"]
MaxLogAssignedPercent	string	El porcentaje máximo de espacio de registros asignado.	6.68
CapacityUnit	object	La unidad de capacidad.
MaxCapacityUnit	integer	La unidad de capacidad máxima.	4
MinCapacityUnit	integer	La unidad de capacidad mínima.	1
UsedCapacityUnit	string	La unidad de capacidad utilizada.	2
UnitSpec	string	Las especificaciones de unidad del servicio de proxy.	2C4G
SharedUnitNumLimit	integer	El límite superior de unidades para el servicio de proxy en modo compartido.	3
ExclusiveUnitNumLimit	integer	El límite superior de unidades para el servicio de proxy en modo exclusivo.	1
EnableReadOnlyReplica	boolean	Indica si se admiten réplicas de solo lectura.	true
EnableReadOnlyReplicaManagement	boolean	Indica si puede adquirir réplicas de solo lectura para el clúster.	false
PrimaryInstance	string	El ID de la instancia principal.	ob3h8ytroxxxxx
PrimaryRegion	string	La región de la instancia principal.	cn-hangzhou
SpecType	string	El tipo de especificación.	dedicatedspec
AllowModifyInternetAddressConnectionLimit	boolean	Indica si se puede modificar el número máximo de conexiones a través de Internet.	false
AllowCreateProxySqlFirewallRule	boolean	Indica si se permite crear reglas de firewall SQL del proxy.	false
Iops	integer		10000

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.