CreateKillInstanceSessionTask - Database Autonomy Service: Central de Documentação do Alibaba Cloud

Descrição da operação

Esta operação é aplicável apenas a instâncias do ApsaraDB RDS for MySQL e PolarDB for MySQL.
Ao usar o SDK do Alibaba Cloud ou do DAS, utilize a versão mais recente.
Ao chamar o DAS usando o SDK, defina a região como cn-shanghai.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

hdm:CreateKillInstanceSessionTask

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância.	rm-2ze8g2am97624****
NodeId	string	Não	O ID do nó. Nota Para instâncias do PolarDB for MySQL, forneça o ID do nó. Se nenhum ID de nó for fornecido e o parâmetro de solicitação KillAllSessions estiver definido como true (encerrar todas as sessões), o sistema percorre todos os nós da instância do PolarDB for MySQL e encerra as sessões em andamento em cada nó.	pi-bp1v203xzzh0a****
DbUser	string	Sim	A conta do banco de dados que tem permissão para encerrar sessões.	testUser
DbUserPassword	string	Sim	A senha da conta do banco de dados.	testPassword
IgnoredUsers	string	Não	A lista de contas cujas sessões não serão encerradas. Nota Os dados estão no formato JSONArray, como ['DatabaseAccount1','DatabaseAccount2']. Separe várias contas de banco de dados com vírgulas (,).	['db_user1','db_user2']
KillAllSessions	boolean	Sim	Especifica se todas as sessões devem ser encerradas. true: Sim. false: Não. Nota Quando este parâmetro está definido como true, as sessões das contas especificadas no parâmetro de solicitação IgnoredUsers, as sessões das contas de operações internas do Alibaba Cloud e as sessões de Binlog Dump não são encerradas.	true
SessionIds	string	Não	A lista de IDs de sessão a serem encerrados. Nota Os dados estão no formato JSONArray, como [SessionID1,SessionID2]. Separe vários IDs de sessão com vírgulas (,). Se o parâmetro de solicitação KillAllSessions estiver definido como true (encerrar todas as sessões), esta lista será ignorada.	[10805639,10805623,10805645,10805553,10805566,10805616]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	integer	O código de status retornado.	200
Message	string	A mensagem retornada. Nota Se a solicitação for bem-sucedida, Successful será retornado. Se a solicitação falhar, uma mensagem de erro, como um código de erro, será retornada.	Successful
Data	string	O ID da tarefa para encerrar sessões. Nota Quando você invoca esta operação de API para uma instância do PolarDB for MySQL com o parâmetro de solicitação NodeId deixado vazio (nenhum ID de nó especificado) e o parâmetro de solicitação KillAllSessions definido como true (encerrar todas as sessões), uma lista de IDs de tarefa é retornada com base no número de nós, como ["f77d535b45405bd462b21caa3ee8**", "e93ab549abb081eb5dcd5396a29b**"].	f77d535b45405bd462b21caa3ee8****
RequestId	string	O ID da solicitação.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "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.	Os parâmetros da solicitação são inválidos.
403	NoPermission	You are not authorized to do this action.	Você não tem as permissões para realizar esta operação.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.