Todos os produtos
Search
Central de documentação

:CreateKillInstanceSessionTask

Última atualização: Jun 27, 2026

Cria uma tarefa para encerrar sessões.

  • Esta operação aplica-se exclusivamente a instâncias do ApsaraDB RDS for MySQL e do PolarDB for MySQL.

  • Se você utilizar um SDK da Alibaba Cloud ou do Database Autonomy Service (DAS) para chamar esta API, use a versão mais recente do SDK.

  • Para acessar o DAS por meio de um SDK, defina o ID da região como cn-shanghai.

Parâmetros da solicitação

ParâmetroTipoObrigatórioExemploDescrição
ActionStringSimCreateKillInstanceSessionTask

A operação a ser executada. Defina o valor como CreateKillInstanceSessionTask.

InstanceIdStringSimrm-2ze8g2am97624****

O ID da instância.

NodeIdStringNãopi-bp1v203xzzh0a****

O ID do nó.

Nota O ID do nó é obrigatório ao consultar sessões de uma instância do PolarDB for MySQL. Se nenhum ID de nó for especificado e o parâmetro KillAllSessions estiver definido como true, o sistema percorre todos os nós da instância do PolarDB for MySQL e encerra as sessões ativas em cada nó.
DbUserStringSimtestUser

A conta de banco de dados com permissões para encerrar sessões.

DbUserPasswordStringSimtestPassword

A senha da conta de banco de dados.

IgnoredUsersStringNão['db_user1','db_user2']

As contas cujas sessões não devem ser encerradas.

Nota O valor deste parâmetro é uma string JsonArray. Separe as contas de banco de dados com vírgulas (,). Exemplo: ['Conta de banco de dados 1','Conta de banco de dados 2'].
KillAllSessionsBooleanSimtrue

Define se todas as sessões devem ser encerradas.

  • true: encerra todas as sessões.
  • false: não encerra todas as sessões.
Nota Se este parâmetro for definido como true, as sessões das contas especificadas pelo parâmetro IgnoredUsers, as sessões de contas internas de O&M da Alibaba Cloud e as sessões Binlog Dump não serão encerradas.
SessionIdsStringNão[10805639,10805623,10805645,10805553,10805566,10805616]

Os IDs das sessões a serem encerradas.

Nota O valor deste parâmetro é uma string JsonArray. Separe os IDs de sessão com vírgulas (,). Exemplo: ['ID de sessão 1','ID de sessão 2']. Se o parâmetro KillAllSessions estiver definido como true, este parâmetro não terá efeito.

Parâmetros de resposta

ParâmetroTipoExemploDescrição
CodeLong200

O código de status HTTP retornado.

MessageStringSuccessful

A mensagem retornada pela solicitação.

Nota Se a solicitação for bem-sucedida, "Successful" será retornado. Em caso de falha, uma mensagem de erro contendo um código de erro será retornada.
DataStringf77d535b45405bd462b21caa3ee8****

O ID da tarefa que encerrou as sessões.

Nota Se as sessões de uma instância do PolarDB for MySQL foram encerradas, o parâmetro NodeId estiver vazio e o parâmetro KillAllSessions estiver definido como true, os IDs das tarefas serão retornados conforme o número de nós. Exemplo: ["f77d535b45405bd462b21caa3ee8****", "e93ab549abb081eb5dcd5396a29b****"]
RequestIdStringB6D17591-B48B-4D31-9CD6-9B9796B2****

O ID da solicitação.

SuccessBooleantrue

Indica se a solicitação foi bem-sucedida. Valores válidos:

  • true: A solicitação foi bem-sucedida.
  • false: A solicitação falhou.

Exemplos

Exemplos de solicitações

http(s)://das.cn-shanghai.aliyuncs.com/?Action=CreateKillInstanceSessionTask
&InstanceId=rm-2ze8g2am97624****
&DbUser=testUser
&DbUserPassword=testPassword
&IgnoredUsers=['db_user1','db_user2']
&KillAllSessions=true
&SessionIds=[10805639,10805623,10805645,10805553,10805566,10805616]
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateKillInstanceSessionTaskResponse>
    <Code>200</Code>
    <Message>Successful</Message>
    <Data>f77d535b45405bd462b21caa3ee8****</Data>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Success>true</Success>
</CreateKillInstanceSessionTaskResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

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

Códigos de erro

Código de status HTTP

Código de erro

Mensagem de erro

Descrição

400

InvalidParams

The request parameters are invalid.

Mensagem de erro retornada porque os parâmetros de solicitação especificados são inválidos.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.