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

Descrição da operação

Método

PUT

URI

/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc

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

*Instance

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

Nenhuma

Sintaxe da solicitação

PUT /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc 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****
clusterName	string	Sim	O nome do cluster.	sz_vpc_domain_1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
body	object	Não	O corpo da solicitação.	{ "description": "Custom description" }

Parâmetro	Obrigatório	Tipo	Descrição
description	Sim	String	A descrição do cluster

Exemplos de solicitações

PUT /openapi/ha3/instances/ha3_instance_name/clusters/my_cluster_name/desc

{
  "description":"this is descrition"
}

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	The response parameters.
requestId	string	O ID da solicitação.	D39EE0F1-D7EF-5F46-B781-6BF4185308B0
result	object	O resultado.	{}

Exemplos de respostas

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

Para mais informações, consulte Estrutura de resposta.

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0",
  "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.