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

Descrição da operação

Método

GET

URI

/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}

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

get

*Instance

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

Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/advanced-configs/{configName} 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****
configName	string	Sim	O nome da configuração avançada.	ha-cn-pl32rf0****_offline_adv_edit

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
type	string	Não	O tipo da configuração avançada. Valores válidos: -ONLINE: configuração online -ONLINE_CAVA: configuração Cava online -ONLINE_PLUGIN: configuração de plug-in online -ONLINE_QUERY: configuração de consulta -OFFLINE_DICT: configuração de dicionário offline -OFFLINE_TABLE: configuração de tabela offline -OFFLINE_COMMON: configuração offline -OFFLINE_PLUGIN: configuração de plug-in offline -OFFLINE_INDEX: configuração de índice	ONLINE

Exemplos de solicitações

GET  /openapi/ha3/instances/ose-test1/advanced-configs/my_config_name

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	The response parameters.
requestId	string	O ID da solicitação.	E45380E8-994A-5402-9806-F114B3295FCF
result	object	O resultado.
updateTime	integer	O horário em que a configuração avançada foi atualizada.	2024-05-21 16:05:26
desc	string	A descrição da configuração avançada.	Custom remarks
files	array<object>	Os arquivos.
	object	Uma matriz de arquivos.
name	string	The file name.	ha-cn-pl32rf0****_qrs
fullPathName	string	The file path.	/cluster
isDir	boolean	Indicates whether the file is a directory.	true
isTemplate	boolean	Indicates whether the file is a container.	true
content	string	O conteúdo da configuração avançada que é retornado.	{\"url\":\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\"}
contentType	string	O tipo do conteúdo da configuração. Valores válidos: FILE, GIT, HTTP e ODPS.	FILE
name	string	O nome da configuração avançada.	my_index
status	string	O status da configuração avançada. Valores válidos: drafting: A configuração avançada está no estado de rascunho. used: A configuração avançada está em uso. unused: A configuração avançada não está em uso. trash: A configuração avançada está sendo excluída.	used

Exemplos de respostas

Respostas de sucesso

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "name": "my_index",
    "status": "drafting",
    "updateTime": 1631070464000,
    "desc":"test",
    "files": [
      {
        "fullPathName": "/",
        "isDir": true,
        "isTemplate": true,
        "name": "cava"
      },
      {
        "fullPathName": "/",
        "isDir": true,
        "isTemplate": true,
        "name": "cava"
      }
    ]    
  }
}

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": {
    "updateTime": 0,
    "desc": "Custom remarks",
    "files": [
      {
        "name": "ha-cn-pl32rf0****_qrs",
        "fullPathName": "/cluster",
        "isDir": true,
        "isTemplate": true
      }
    ],
    "content": "{\\\"url\\\":\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\"}",
    "contentType": "FILE",
    "name": "my_index",
    "status": "used"
  }
}

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.