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

Obtiene la información general de las instancias 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:DescribeInstanceSummary

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
PageSize	integer	No	El número de filas que se devolverán en cada página. Valor máximo: 100. Valor predeterminado: 10.	10
PageNumber	integer	No	El número de la página que se devolverá. Valor inicial: 1 Valor predeterminado: 1	1

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El resultado devuelto de la solicitud.
RequestId	string	El ID de la solicitud.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
InstanceSummary	object	La información general de las instancias de OceanBase.
TotalInstancesCount	integer	El número total de instancias.	3
OverLoadInstancesCount	integer	El número de instancias sobrecargadas.	1
ImmediatelyExpiredInstancesCount	integer	El número total de instancias caducadas que se liberarán.	1
RunningInstancesCount	integer	El número de instancias en ejecución.	1
InsufficientDiskInstancesCount	integer	El número total de clústeres con riesgos de capacidad.	2
ExpiredInstancesCount	integer	El número de instancias caducadas.	1
AlarmSummaryCount	integer	El número total de alertas durante el período de consulta.	1
AnomalySQLCount	integer	El número total de sentencias SQL anómalas.	1
ClusterInstancesCount	integer	El número de instancias de clúster.	1
TenantInstancesCount	integer	El número de instancias de inquilino.	1
TotalOmsInstancesCount	integer	El número de instancias de transmisión de datos.	1
RegionalInstanceSummaryList	array<object>	Una lista de instancias regionales.
	object
Region	string	El ID de la región.	cn-shanghai
TotalInstancesCount	integer	El número total de instancias.	3
ImmediatelyExpiredInstancesCount	integer	El número de instancias próximas a caducar.	1
RunningInstancesCount	integer	El número total de instancias en ejecución.	1
ExpiredInstancesCount	integer	El número de instancias caducadas.	1
RecentCreatedInstancesCount	integer	El número de instancias creadas recientemente.	1

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "InstanceSummary": {
    "TotalInstancesCount": 3,
    "OverLoadInstancesCount": 1,
    "ImmediatelyExpiredInstancesCount": 1,
    "RunningInstancesCount": 1,
    "InsufficientDiskInstancesCount": 2,
    "ExpiredInstancesCount": 1,
    "AlarmSummaryCount": 1,
    "AnomalySQLCount": 1,
    "ClusterInstancesCount": 1,
    "TenantInstancesCount": 1,
    "TotalOmsInstancesCount": 1,
    "RegionalInstanceSummaryList": [
      {
        "Region": "cn-shanghai",
        "TotalInstancesCount": 3,
        "ImmediatelyExpiredInstancesCount": 1,
        "RunningInstancesCount": 1,
        "ExpiredInstancesCount": 1,
        "RecentCreatedInstancesCount": 1
      }
    ]
  }
}

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.