CreateKillInstanceSessionTask - Database Autonomy Service - Centro de documentación de Alibaba Cloud

Descripción de la operación

Esta operación solo es aplicable a instancias de ApsaraDB RDS for MySQL y PolarDB for MySQL.
Al utilizar el SDK de Alibaba Cloud o de DAS, utilice la versión más reciente.
Al llamar a DAS mediante el SDK, establezca la región en cn-shanghai.

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

hdm:CreateKillInstanceSessionTask

create

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
InstanceId	string	Sí	El ID de la instancia.	rm-2ze8g2am97624****
NodeId	string	No	El ID del nodo. Nota Para las instancias de PolarDB for MySQL, proporcione el ID del nodo. Si no se proporciona un ID de nodo y el parámetro de solicitud KillAllSessions se establece en true (finalizar todas las sesiones), el sistema recorre todos los nodos de la instancia de PolarDB for MySQL y finaliza las sesiones activas en cada nodo.	pi-bp1v203xzzh0a****
DbUser	string	Sí	La cuenta de base de datos que tiene permiso para finalizar sesiones.	testUser
DbUserPassword	string	Sí	La contraseña de la cuenta de base de datos.	testPassword
IgnoredUsers	string	No	La lista de cuentas cuyas sesiones no se finalizarán. Nota Los datos están en formato JSONArray, como ['DatabaseAccount1','DatabaseAccount2']. Separe varias cuentas de base de datos con comas (,).	['db_user1','db_user2']
KillAllSessions	boolean	Sí	Especifica si se deben finalizar todas las sesiones. true: Sí. false: No. Nota Cuando este parámetro se establece en true, no se finalizan las sesiones de las cuentas especificadas en el parámetro de solicitud IgnoredUsers, las sesiones de las cuentas de operaciones internas de Alibaba Cloud ni las sesiones de Binlog Dump.	true
SessionIds	string	No	La lista de ID de sesión que se van a finalizar. Nota Los datos están en formato JSONArray, como [SessionID1,SessionID2]. Separe varios ID de sesión con comas (,). Si el parámetro de solicitud KillAllSessions se establece en true (finalizar todas las sesiones), esta lista se ignora.	[10805639,10805623,10805645,10805553,10805566,10805616]

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
Code	integer	El código de estado devuelto.	200
Message	string	El mensaje devuelto. Nota Si la solicitud se realiza correctamente, se devuelve Successful. Si la solicitud falla, se devuelve un mensaje de error, como un código de error.	Successful
Data	string	El ID de la tarea para finalizar sesiones. Nota Cuando invoca esta operación de API para una instancia de PolarDB for MySQL con el parámetro de solicitud NodeId vacío (sin ID de nodo especificado) y el parámetro de solicitud KillAllSessions establecido en true (finalizar todas las sesiones), se devuelve una lista de ID de tarea según el número de nodos, como ["f77d535b45405bd462b21caa3ee8**", "e93ab549abb081eb5dcd5396a29b**"].	f77d535b45405bd462b21caa3ee8****
RequestId	string	El ID de la solicitud.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	boolean	Indica si la solicitud se realizó correctamente. true: La solicitud se realizó correctamente. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "Code": 200,
  "Message": "Successful",
  "Data": "f77d535b45405bd462b21caa3ee8****",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permissions to perform this operation.

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.