Todos los productos
Search
Centro de documentos

ApsaraDB for OceanBase (Deprecated):SwitchoverInstance

Última actualización: Sep 02, 2026

Permite alternar entre las instancias principal y en espera 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:SwitchoverInstance

update

*All Resource

*

Ninguna Ninguna

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

InstanceId

string

Sí

El ID de la instancia principal o en espera. Puede establecer el valor predeterminado como el ID de la instancia que se convertirá en la instancia principal.

ob317v4uif****

TargetInstanceId

string

Sí

El ID de la instancia que se convertirá en la instancia principal.

ob4bv8o7sp****

Forced

boolean

No

Especifica si se debe forzar la conmutación.

  • true: fuerza la conmutación.

  • false: no fuerza la conmutación.

true

Elementos de la respuesta

Elemento

Tipo

Descripción

Ejemplo

object

El resultado devuelto de la solicitud.

RequestId

string

El ID de la solicitud.

473469**-AA6F-4D**-B3DB-A***********

Data

object

La lista de datos de la conmutación.

Message

string

El mensaje de la conmutación.

delete tag-value success

Success

boolean

Indica si la conmutación se realizó correctamente.

  • true: la conmutación se realizó correctamente.

  • false: la conmutación falló.

true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "473469**-AA6F-4D**-B3DB-A***********",
  "Data": {
    "Message": "delete tag-value success",
    "Success": true
  }
}

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.