ExecuteSqlInstance - OpenSearch: Central de Documentação do Alibaba Cloud

Executa uma instância SQL.

Descrição da operação

Método

POST

URI

/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/execution

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

searchengine:ExecuteSqlInstance

create

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

Nenhuma

Sintaxe da solicitação

POST /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}/actions/execution HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância.	ha-cn-pl32rf0****
database	string	Sim	O nome do banco de dados.	general
sqlInstanceId	integer	Sim	O ID da instância SQL.	1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
body	object	Não	Os parâmetros do corpo da solicitação.
content	string	Sim	O conteúdo SQL.	select * from test
kvpair	object	Não	A estrutura de chave-valor.
	any	Não	A estrutura de chave-valor.	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
dynamicParam	object	Não	Os parâmetros dinâmicos.
	any	Não	Os parâmetros de extensão dinâmica.	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
staticParam	object	Não	Os parâmetros estáticos.
	any	Não	Os parâmetros estáticos.	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
domain	string	Não	A sala de servidores da fonte de dados.	vpc_hz_domain_1
params	object	Não	Os parâmetros de execução SQL.
	any	Não	Os parâmetros de execução SQL.	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }
combineParam	object	Não	Os parâmetros combinados.
	any	Não	Os parâmetros combinados.	{ "trace": "INFO", "databaseName": "general", "iquan.plan.cache.enable": true, "iquan.plan.prepare.level": "jni.post.optimize", "urlencode_data": false, "formatType": "string", "timeout": 1000 }

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	FE03180A-0E29-5474-8A86-33F0683294A4
result	object	O resultado retornado.
id	integer	O ID da chave primária.	22
gmtCreate	string	A hora de criação.	1719221186114
gmtModified	string	A hora de modificação.	1719220182844
name	string	O nome.	test
parent	integer	O ID da tarefa pai.	-1
isDir	integer	Indica se a entrada é um diretório. Valores válidos: true: A entrada é um diretório. false: A entrada não é um diretório.	true
type	string	tabela, instância, modelo, função.	instance
instanceId	integer	O ID da instância.	ha-cn-pl32rf0****
templateId	integer	O ID do modelo.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "FE03180A-0E29-5474-8A86-33F0683294A4",
  "result": {
    "id": 22,
    "gmtCreate": "1719221186114",
    "gmtModified": "1719220182844",
    "name": "test",
    "parent": -1,
    "isDir": 0,
    "type": "instance",
    "instanceId": 0,
    "templateId": 1
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.