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

Descrição da operação

Sintaxe da solicitação

PUT /openapi/ha3/instances/{instanceId}/cluster-offline-config

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

update

*Instance

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

Nenhuma

Sintaxe da solicitação

PUT /openapi/ha3/instances/{instanceId}/cluster-offline-config 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****

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
body	object	Não	O corpo da solicitação.	{}
dataSourceName	string	Não	O nome da fonte de dados.	ha-cn-pl32rf0****_test_api
dataSourceType	string	Não	O tipo da fonte de dados. Valores válidos: odps: MaxCompute. swift: Swift. unKnow: tipo desconhecido.	odps
domain	string	Não	O data center no qual a fonte de dados está implantada.	vpc_hz_domain_1
config	object	Não	O nome da configuração, que é armazenado como uma chave.
	integer	Não	A versão da configuração, que é armazenada como um valor.	1
partition	string	Não	Este parâmetro é obrigatório quando a construção de índice para dados completos em uma fonte de dados MaxCompute é acionada.	ds=20211202
dataTimeSec	integer	Não	Este parâmetro é obrigatório quando a construção de índice usando fontes de dados de API é acionada.	1640867288
buildMode	string	Não	O método de reindexação. Valores válidos: api: fonte de dados de API. indexRecover: recuperação de dados usando indexação.	indexRecover
generation	integer	Não	O ID da versão do índice completo.	160142641
pushMode	string	Não	O modo de push da configuração. Por padrão, apenas a configuração é enviada.	PUSH_ONLY

Parâmetro	Obrigatório	Tipo	Descrição
dataSource	Sim	String	O nome da fonte de dados.
domain	Sim	String	O domínio onde a fonte de dados está implantada.
indexes	Sim	Object	A descrição da estrutura do índice.
advancedConfigVersionId	Sim	Integer	O ID da versão da configuração avançada.
triggerBuild	Sim	boolean	Se este parâmetro for definido como true, a configuração será enviada e a reindexação será acionada. Se este parâmetro for definido como false, a configuração entrará em vigor após a próxima reindexação.
buildMode	Não	Integer	O modo de reindexação. api indica o modo padrão e indexRecover indica que a fonte de dados é restaurada usando o índice. Este parâmetro é obrigatório apenas quando a fonte de dados é do tipo HDFS.
generation	Não	Long	A versão de restauração de dados.
partition	Não	String	A partição de dados da fonte de dados selecionada para reindexação. Este parâmetro é obrigatório quando a reindexação é acionada para a fonte de dados odps.
dataTimeSec	Não	Integer	O horário em que a reindexação é acionada para a fonte de dados enviada por API. O valor deste parâmetro deve ser preciso até o segundo. Este parâmetro é obrigatório quando a reindexação é acionada para a fonte de dados enviada por API.
dataSourceType	Não	Enum	Este parâmetro é obrigatório quando o parâmetro triggerBuild é definido como true. Valores válidos: odps e swift.

Exemplos de solicitação

PUT /openapi/ha3/instances/ha3_instance_name/cluster-offline-config

{
    "dataSource": "test1",
    "domain": "xx",
    "indexes": [
        {
            "name": "index1",
            "versionId": 1
        },
        {
            "name": "index2",
            "versionId": 1
        }
    ],
    "advancedConfigVersionId": 2,
    "triggerBuild": true,
    "partition": "20201010", // Este parâmetro é obrigatório quando a reindexação é acionada para a fonte de dados odps.
    "dataSourceType": "odps", // Este parâmetro é obrigatório. Defina este parâmetro como odps ou swift. Uma mensagem de erro será retornada se você não definir este parâmetro.
    "dataTimeSec": 1640867288 // Este parâmetro especifica o horário em que a reindexação é acionada para a fonte de dados enviada por API. O valor deste parâmetro deve ser preciso até o segundo. Este parâmetro é obrigatório quando a reindexação é acionada para a fonte de dados enviada por API.
  
}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Schema of Response
requestId	string	O ID da solicitação.	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	O resultado.	{}

Exemplo de resposta

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": []
}

Para mais detalhes, consulte Estrutura de resposta

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {}
}

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.