UpdateSynonymsDicts - Elasticsearch: Central de Documentação do Alibaba Cloud

Observe os pontos a seguir ao chamar esta API:

Se o arquivo de dicionário for obtido do OSS, verifique se o bucket do OSS tem permissão de leitura pública.
Caso a configuração ORIGIN não esteja presente em um arquivo de dicionário enviado, o sistema excluirá esse arquivo após a execução desta operação.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Cabeçalhos da requisição

Esta operação utiliza apenas parâmetros de requisição comuns e não envolve cabeçalhos especiais. Para mais informações, consulte o tópico sobre parâmetros comuns.

Sintaxe da requisição

PUT /openapi/instances/[InstanceId]/synonymsDict HTTP/1.1

Parâmetros da requisição

Parâmetro	Tipo	Posição	Obrigatório	Exemplo	Descrição
InstanceId	String	Path	Sim	es-cn-nif1q9o8r0008****	ID da instância.
clientToken	String	Query	Não	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Garante a idempotência da requisição. Use o cliente para gerar o valor, mas assegure que ele seja único entre diferentes requisições. O token pode conter apenas caracteres ASCII e não deve exceder 64 caracteres.

RequestBody

Insira os seguintes parâmetros no RequestBody.

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
name	String	Sim	dic_0.txt	Nome do arquivo de dicionário enviado. Deve ser um arquivo TXT.
ossObject	Array	Não		Descrição do arquivo no OSS. Obrigatório quando sourceType é definido como OSS.
└bucketName	String	Não	search-cloud-test-cn-****	Nome do bucket do OSS.
└key	String	Não	oss/dic_0.txt	Caminho do arquivo de dicionário no bucket do OSS.
sourceType	String	Sim	OSS	Tipo de origem do arquivo de dicionário. Valores válidos: OSS (armazenamento aberto usando OSS) e ORIGIN (mantém os dicionários enviados anteriormente). Nota: Envie o arquivo local para o OSS e referencie-o por meio dele. Se um dicionário enviado não estiver configurado com ORIGIN, o sistema o excluirá.
type	String	Sim	SYNONYMS	Tipo do dicionário a ser atualizado. Valor fixo: SYNONYMS.

Nota

└ indica um parâmetro filho.

Exemplos:

[
    {
        "name":"deploy_0.txt",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_0.dic"
        },
        "sourceType":"OSS",
        "type":"MAIN"
    },
    {
        "name":"SYSTEM_MAIN.txt",
        "type":"MAIN",
        "sourceType":"ORIGIN"
    },
    {
        "name":"SYSTEM_STOPWORD.txt",
        "type":"STOP",
        "sourceType":"ORIGIN"
    }
]

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	7C5622CC-B312-426F-85AA-B0271*******	ID da requisição.
Result	Array of DictList		Resultados retornados.
fileSize	Long	220	Tamanho do arquivo de dicionário. Unidade: bytes.
name	String	deploy_0.txt	Nome do arquivo de dicionário.
sourceType	String	OSS	Tipo de origem do arquivo de dicionário. Valores válidos: OSS: armazenamento aberto do OSS. ORIGIN: mantém os dicionários já enviados.
type	String	SYNONYMS	Tipo do dicionário. Valor válido: SYNONYMS.

Exemplos

Exemplos de requisição

PUT /openapi/instances/es-cn-nif1q9o8r0008****/synonymsDict HTTP/1.1
common request header
[
    {
        "name":"deploy_0.txt",
        "ossObject":{
            "bucketName":"search-cloud-test-cn-****",
            "key":"user_dict/dict_0.dic"
        },
        "sourceType":"OSS",
        "type":"SYNONYMS"
    },
    {
        "name":"SYSTEM_STOPWORD.txt",
        "sourceType":"ORIGIN",
        "type":"SYNONYMS"
    }
]

Exemplos de resposta de sucesso

Formato JSON

{
    "Result": [

        {
            "name":"deploy_0.txt",
            "fileSize":220,
            "sourceType":"OSS",
            "type":"SYNONYMS"
        },
        {
            "name":"SYSTEM_MAIN.txt",
            "fileSize":2782602,
            "sourceType":"ORIGIN",
            "type":"SYNONYMS"
        },
        {
            "name":"SYSTEM_STOPWORD.txt",
            "fileSize":132,
            "sourceType":"ORIGIN",
            "type":"SYNONYMS"
        }
    ],
    "RequestId": "1F7FE662-CCD8-474F-BA9B-A7E0792E****"
}

Código de erro

Para obter uma lista de códigos de erro, visite a Central de Erros da API.