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

Descrição da operação

Método

POST

URI

/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders
```.

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:CreateFolder

create

*Folder

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

Nenhuma

Sintaxe da solicitação

POST /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders 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

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.
name	string	Sim	O nome da pasta.	gist_qc
parent	integer	Sim	O ID da categoria pai (obrigatório). Se deixado vazio, o valor padrão é 1.	1
type	string	Sim	table, instance, template, function.	instance

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	O resultado retornado.
id	integer	O ID da pasta.	25030
gmtCreate	string	A hora de criação.	1719221186114
gmtModified	string	A hora de atualização.	1719221186114
name	string	O nome.	test
parent	integer	O ID do nível pai.	-1
isDir	integer	Indica se a entrada é uma pasta. Valores válidos: true: A entrada é uma pasta. false: A entrada não é uma pasta.	True
type	string	table, instance, template, function.	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": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {
    "id": 25030,
    "gmtCreate": "1719221186114",
    "gmtModified": "1719221186114",
    "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.