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

Obtiene una lista de clústeres 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:DescribeInstances

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	No	El ID del clúster de OceanBase.	ob317v4uif****
ResourceGroupId	string	No	El ID del grupo de recursos. Si omite este parámetro, la API devuelve instancias de todos los grupos de recursos.	group1
PageSize	integer	No	El número de entradas que se devolverán en cada página. Valor máximo: 100. Valor predeterminado: 10.	10
PageNumber	integer	No	El número de página. Comienza desde 1. Valor predeterminado: 1.	1
InstanceName	string	No	El nombre del clúster de OceanBase. El nombre debe tener entre 1 y 20 caracteres de longitud y puede contener caracteres en inglés o chino. Si no se especifica este parámetro, el valor predeterminado es el ID de instancia del clúster.	ob4prod
SearchKey	string	No	La palabra clave para realizar una búsqueda aproximada por ID de instancia, nombre de instancia, ID de inquilino y nombre de inquilino.	pay
WithOBCloudInstances	boolean	No

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Los datos devueltos.
Instances	array<object>	Detalles de los clústeres de OceanBase.
	array<object>	Detalles de un único clúster de OceanBase.
VpcId	string	El ID de la VPC.	vpc-8vb8qjrixzovjpy******
CommodityCode	string	El código de producto del clúster de OceanBase. `oceanbase_oceanbasepre_public_cn`: indica un clúster de OceanBase de suscripción en el sitio de China. `oceanbase_oceanbasepost_public_cn`: indica un clúster de OceanBase de pago por uso en el sitio de China. `oceanbase_obpre_public_intl`: indica un clúster de OceanBase de suscripción en el sitio internacional. `oceanbase_obpost_public_intl`: indica un clúster de OceanBase de pago por uso en el sitio internacional.	oceanbase_oceanbasepost_public_cn
ExpireTime	string	La hora de caducidad del clúster, en UTC. Nota Este parámetro se devuelve solo para instancias de suscripción.	2021-10-17T16:00:00Z
State	string	El estado del clúster. `ONLINE`: En ejecución. `PENDING_CREATE`: Creando. `ARREARS_CLOSED`: El clúster de pago por uso se ha cerrado debido a un pago vencido. `PREPAID_EXPIRE_CLOSED`: El clúster de suscripción se ha cerrado tras su caducidad. `WHITE_LIST_MODIFYING`: Se está modificando la lista blanca de IP. `SSL_MODIFYING`: Se está cambiando la configuración SSL. `PARAMETER_MODIFYING`: Se están modificando los parámetros. `TENANT_CREATING`: Se está creando un inquilino. `TENANT_SPEC_MODIFYING`: Se está modificando el tipo de instancia de un inquilino. `EXPANDING`: Se están escalando horizontalmente los nodos. `REDUCING`: Se están reduciendo los nodos. `ZONE_CHANGING`: Se están cambiando las zonas de disponibilidad. `SPEC_UPGRADING`: Se está escalando verticalmente el tipo de instancia. `SPEC_DOWNGRADING`: Se está reduciendo verticalmente el tipo de instancia. `DISK_UPGRADING`: Se está escalando verticalmente el espacio de almacenamiento. `UPGRADING`: Se está actualizando el clúster. `PENDING_DELETE`: El clúster se está eliminando. `DELETED`: El clúster está eliminado. `ABNORMAL`: El clúster se encuentra en un estado anómalo. `OFFLINE`: El clúster está sin conexión. `STANDBY_CREATING`: Se está creando un clúster en espera. `STANDBY_DELETING`: Se está eliminando un clúster en espera. `SWITCHOVER_SWITCHING`: Hay una conmutación principal/en espera en curso. `STANDBY_DISCONNECTING`: Se está desvinculando un clúster en espera. `LOG_DISK_UPGRADING`: Se está escalando verticalmente el disco de registros. `ISOLATION_OPTIMIZATION_MODIFYING`: Se está cambiando la configuración de optimización de aislamiento. `DISKTYPE_MODIFYING`: Se está cambiando el tipo de disco de datos. `PROXY_SERVICE_CREATING`: Se está habilitando el servicio de proxy. `PROXY_SERVICE_DELETING`: Se está deshabilitando el servicio de proxy. `PROXY_SERVICE_SPEC_MODIFYING`: Se están modificando las especificaciones del servicio de proxy. `READONLY_ADD_NODE`: Se está agregando un nodo de solo lectura. `READONLY_REDUCE_NODE`: Se está eliminando un nodo de solo lectura. `READONLY_REDUCE_ZONE`: Se está eliminando la zona de disponibilidad para la réplica de solo lectura. `READONLY_ADD_ZONE`: Se está agregando la zona de disponibilidad para la réplica de solo lectura. `READONLY_UPGRADE_SPEC`: Se está escalando verticalmente el tipo de instancia de la réplica de solo lectura. `READONLY_UPGRADE_DISK`: Se está escalando verticalmente el espacio de almacenamiento de la réplica de solo lectura. `READONLY_DOWNGRADE_SPEC`: Se está reduciendo verticalmente el tipo de instancia de la réplica de solo lectura. `READONLY_DOWNGRADE_DISK`: Se está reduciendo verticalmente el espacio de almacenamiento de la réplica de solo lectura. `CREATING_TENANT_READONLY_REPLICA`: Se está creando una réplica de solo lectura para el inquilino. `DELETING_TENANT_READONLY_REPLICA`: Se está eliminando la réplica de solo lectura del inquilino. `DISK_DOWNGRADING`: Se está reduciendo verticalmente el espacio de almacenamiento. `DEPLOY_MODE_MODIFYING`: Se está cambiando el modo de despliegue. Nota Por lo general, un clúster se encuentra en estado En ejecución (`ONLINE`).	ONLINE
InstanceClass	string	El tipo de instancia del clúster. Los tipos admitidos incluyen: `4C16GB`: 4 núcleos, 16 GB de memoria. `8C32GB`: 8 núcleos, 32 GB de memoria. `14C70GB`: 14 núcleos, 70 GB de memoria. `24C120GB`: 24 núcleos, 120 GB de memoria. `30C180GB`: 30 núcleos, 180 GB de memoria. `62C400GB`: 62 núcleos, 400 GB de memoria. `104C600GB`: 104 núcleos, 600 GB de memoria. `16C70GB`: 16 núcleos, 70 GB de memoria. `32C160GB`: 32 núcleos, 160 GB de memoria. `64C380GB`: 64 núcleos, 380 GB de memoria. `20C32GB`: 20 núcleos, 32 GB de memoria. `40C64GB`: 40 núcleos, 64 GB de memoria. `16C32GB`: 16 núcleos, 32 GB de memoria. `32C70GB`: 32 núcleos, 70 GB de memoria. `64C180GB`: 64 núcleos, 180 GB de memoria. `32C180GB`: 32 núcleos, 180 GB de memoria. `64C400GB`: 64 núcleos, 400 GB de memoria.	14C70G
CreateTime	string	La hora en la que se creó el clúster, en UTC.	2021-10-19T07:13:41Z
DeployMode	string	El modo de distribución de réplicas de datos, con formato `n-n-n`. Cada `n` representa el número de nodos OBServer en un centro de datos.	1-1-1
CpuArchitecture	string	La arquitectura de CPU del clúster.	X86_64、 AARCH64
MaintainTime	string	La ventana de mantenimiento diario del clúster, en UTC.	19:00Z-20:00Z
DeployType	string	El tipo de despliegue del clúster. `multiple`: múltiples centros de datos. `single`: un solo centro de datos. `dual`: doble centro de datos.	multiple
PayType	string	El método de facturación del clúster de OceanBase: `PREPAY`: suscripción. `POSTPAY`: pago por uso.	PREPAY
DiskSize	integer	El espacio de almacenamiento, en GB.	200
DiskType	string	El tipo de almacenamiento del clúster.	cloud_essd_pl1
InstanceId	string	El ID del clúster de OceanBase.	ob317v4uif****
ExpireSeconds	integer	El período de validez restante del clúster, en segundos. Nota Para clústeres de suscripción, si el clúster no ha caducado, este parámetro indica el período de validez restante. Si el clúster ha caducado, este parámetro indica la duración desde la caducidad.	2606682
Mem	integer	El tamaño de memoria, en GB.	70
EnableUpgradeNodes	boolean	Indica si puede agregar nuevos nodos.	true
Cpu	integer	El número de núcleos de CPU.	14
AvailableZones	array	Las zonas de disponibilidad donde se despliega el clúster.
	string	Una zona de disponibilidad donde se despliega el clúster.	cn-hangzhou-i
Version	string	La versión de OBServer.	2.2.77
InstanceName	string	El nombre del clúster de OceanBase. El nombre debe tener entre 1 y 20 caracteres de longitud y puede contener letras o caracteres chinos. Si no se especifica este parámetro, se utiliza el valor de `InstanceId` de forma predeterminada.	ob4test
Series	string	La serie de la instancia de OceanBase. `normal` (predeterminado): Edición de clúster estándar (disco en la nube). `normal_ssd`: Edición de clúster estándar (disco local). `history`: Edición de clúster de base de datos histórica. `normal_kv`: Clúster OBKV. `normal_hg`: un clúster de computación confiable.	NORMAL
UsedDiskSize	integer	El espacio de almacenamiento utilizado, en GB.	20
ResourceGroupId	string	El ID del grupo de recursos.	group1
Resource	object	La información de recursos del clúster.
Cpu	object	La información de recursos de CPU del clúster.
TotalCpu	number	El número total de núcleos de CPU.	14
UsedCpu	number	El número de núcleos de CPU utilizados.	10
UnitCpu	number	El número de núcleos de CPU por nodo de réplica.	10
OriginalTotalCpu	number	El número total original de núcleos de CPU.	14
Memory	object	La información de recursos de memoria del clúster.
TotalMemory	number	El tamaño total de memoria, en GB.	70
UsedMemory	integer	La cantidad de memoria utilizada, en GB.	10
UnitMemory	integer	El tamaño de memoria de cada nodo de réplica, en GB.	10
OriginalTotalMemory	number	El tamaño total de memoria original.	72
DiskSize	object	La información de recursos de almacenamiento del clúster.
TotalDiskSize	number	El espacio de almacenamiento total, en GB.	200
UsedDiskSize	integer	El espacio de almacenamiento utilizado, en GB.	100
UnitDiskSize	number	El espacio de almacenamiento de cada nodo de réplica, en GB.	200
OriginalTotalDiskSize	number	El tamaño total original del disco.	200
UnitCount	integer	El número de unidades de recursos en el clúster.	1
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	integer	El número de unidades de capacidad utilizadas.	2
InstanceType	string	El tipo de la instancia. `cluster`: instancia de clúster. `mtenant`: instancia de inquilino en modo MySQL. `mtenant_serverless`: instancia Serverless en modo MySQL.	CLUSTER
InstanceRole	string	El rol de la instancia.	NORMAL
InTempCapacityStatus	boolean	Indica si el clúster tiene capacidad temporal.	false
DataDiskAutoScaleConfig	object	La configuración de escalado automático del disco de datos.
AutoScale	boolean	Indica si el escalado automático está habilitado.	true
Upperbound	number	El límite superior para el escalado.	16
UpperThreshold	number	El umbral para el escalado rutinario.	80
UpperMergeThreshold	number	El umbral para el escalado horizontal durante las compactaciones principales.	90
MaxDiskSize	integer	El tamaño máximo del disco.	80000
ScaleStepInNormal	number	El tamaño del incremento para el escalado rutinario.	50
ScaleStepInMerge	number	El tamaño del incremento para el escalado durante las compactaciones principales.	100
UpperScaleStrategy	string	La estrategia de escalado. Valores válidos: `RAW` y `PERCENTAGE`.	RAW
EnableReadOnlyReplicaManagement	boolean	Indica si se pueden adquirir réplicas de solo lectura para el clúster.	yes
SpecType	string	El tipo de especificación.	dedicatedspec
ObRpmVersion	string	La versión RPM del clúster.	4.2.1.7-107030032024062709
ReplicaMode	string	El modo de réplica del clúster.	3F、2F1A
Migratable	boolean
MigrationInfo	object	Información sobre la migración a Alibaba Cloud Marketplace.
Migratable	boolean	Indica si la instancia se puede migrar.
CheckResult	object	Proporciona el motivo si no se admite la migración.
Level	string	El nivel del resultado de la verificación.
Code	string	El código del elemento de verificación.
CodeName	string	La descripción del elemento de verificación.
Module	string	El nombre del módulo.
ModuleName	string	El nombre para mostrar del módulo.
SubModule	string	El nombre del submódulo.
SubModuleName	string	El nombre para mostrar del submódulo.
Iops	integer		10000
TotalCount	integer	El número total de clústeres devueltos.	2
RequestId	string	El ID de la solicitud.	EE205C00-30E4-**-**-87E3A8A2AA0C

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Instances": [
    {
      "VpcId": "vpc-8vb8qjrixzovjpy******",
      "CommodityCode": "oceanbase_oceanbasepost_public_cn",
      "ExpireTime": "2021-10-17T16:00:00Z",
      "State": "ONLINE",
      "InstanceClass": "14C70G",
      "CreateTime": "2021-10-19T07:13:41Z",
      "DeployMode": "1-1-1",
      "CpuArchitecture": "X86_64、 AARCH64",
      "MaintainTime": "19:00Z-20:00Z",
      "DeployType": "multiple",
      "PayType": "PREPAY",
      "DiskSize": 200,
      "DiskType": "cloud_essd_pl1",
      "InstanceId": "ob317v4uif****",
      "ExpireSeconds": 2606682,
      "Mem": 70,
      "EnableUpgradeNodes": true,
      "Cpu": 14,
      "AvailableZones": [
        "cn-hangzhou-i"
      ],
      "Version": "2.2.77",
      "InstanceName": "ob4test",
      "Series": "NORMAL",
      "UsedDiskSize": 20,
      "ResourceGroupId": "group1",
      "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,
          "OriginalTotalDiskSize": 200
        },
        "UnitCount": 1,
        "CapacityUnit": {
          "MaxCapacityUnit": 4,
          "MinCapacityUnit": 1,
          "UsedCapacityUnit": 2
        }
      },
      "InstanceType": "CLUSTER",
      "InstanceRole": "NORMAL",
      "InTempCapacityStatus": false,
      "DataDiskAutoScaleConfig": {
        "AutoScale": true,
        "Upperbound": 16,
        "UpperThreshold": 80,
        "UpperMergeThreshold": 90,
        "MaxDiskSize": 80000,
        "ScaleStepInNormal": 50,
        "ScaleStepInMerge": 100,
        "UpperScaleStrategy": "RAW"
      },
      "EnableReadOnlyReplicaManagement": true,
      "SpecType": "dedicatedspec",
      "ObRpmVersion": "4.2.1.7-107030032024062709",
      "ReplicaMode": "3F、2F1A",
      "Migratable": false,
      "MigrationInfo": {
        "Migratable": false,
        "CheckResult": {
          "Level": "",
          "Code": "",
          "CodeName": "",
          "Module": "",
          "ModuleName": "",
          "SubModule": "",
          "SubModuleName": ""
        }
      },
      "Iops": 10000
    }
  ],
  "TotalCount": 2,
  "RequestId": "EE205C00-30E4-****-****-87E3A8A2AA0C"
}

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.