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 clusters do PolarDB for MySQL.
Se você usar um SDK do Alibaba Cloud ou um SDK do Database Autonomy Service (DAS) para chamar esta operação, recomendamos que use a versão mais recente do SDK.
Se você usar um SDK para chamar operações do DAS, deverá definir o ID da 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

*All Resource

*

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 Este parâmetro deve ser especificado se a instância de banco de dados for um cluster do PolarDB for MySQL. Se você não especificar um ID de nó e definir KillAllSessions como true, o sistema percorrerá todos os nós no cluster do PolarDB for MySQL e encerrará as sessões ativas em cada nó.	pi-bp1v203xzzh0a****
DbUser	string	Sim	A conta do banco de dados que tem as permissões para encerrar sessões.	testUser
DbUserPassword	string	Sim	A senha da conta do banco de dados.	testPassword
IgnoredUsers	string	Não	A conta cujas sessões não precisam ser encerradas. Nota Defina este parâmetro como um array JSON. Separe as contas de banco de dados com vírgulas (,). Exemplo: ['Conta de banco de dados 1','Conta de banco de dados 2'].	['db_user1','db_user2']
KillAllSessions	boolean	Sim	Especifica se todas as sessões devem ser encerradas. true false Nota Se você definir este parâmetro como true, as sessões das contas especificadas por IgnoredUsers, as sessões das contas internas de O&M do Alibaba Cloud e as sessões de Binlog Dump não serão encerradas.	true
SessionIds	string	Não	Os IDs das sessões que precisam ser encerradas. Nota Defina este parâmetro como um array JSON. Separe os IDs de sessão com vírgulas (,). Exemplo: ['ID de sessão 1','ID de sessão 2']. Se KillAllSessions estiver definido como true, este parâmetro não terá efeito.	[10805639,10805623,10805645,10805553,10805566,10805616]

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	The response parameters.
Code	integer	O código de status HTTP retornado.	200
Message	string	A mensagem retornada. Nota Se a solicitação for bem-sucedida, Successful é 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 que encerrou as sessões. Nota Se as sessões de um cluster do PolarDB for MySQL foram encerradas, NodeId foi deixado vazio e KillAllSessions foi definido como true, os IDs das tarefas são retornados com base no número de nós. Exemplo: ["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. Valores válidos: true false	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.
403	NoPermission	You are not authorized to do this action.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.