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

Ao chamar esta operação, observe os seguintes pontos:

Não é possível modificar o nome da instância quando ela está nos estados activating, invalid ou inactive.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos que você chame esta operação no OpenAPI Explorer. Use o OpenAPI Explorer para pesquisar operações de API, chamá-las e gerar dinamicamente códigos de exemplo do SDK.

Cabeçalho da requisição

Esta operação utiliza apenas cabeçalhos de requisição comuns. Para mais informações, consulte Parâmetros comuns.

Sintaxe da requisição

PATCH|POST /openapi/logstashes/[InstanceId]/description HTTPS|HTTP

Parâmetros da requisição

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
InstanceId	String	Sim	ls-cn-n6w1o5jq****	O ID da instância.
clientToken	String	Não	5A2CFF0E-5718-45B5-9D4D-70B3FF****	Token exclusivo gerado pelo cliente para garantir a idempotência da requisição. Esse valor deve ser único entre diferentes requisições e ter no máximo 64 caracteres ASCII.

RequestBody

Insira o campo description no parâmetro RequestBody para especificar o novo nome da instância. Exemplo:

{
    "description": "logstash_name"
}

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****	O ID da requisição.
Result	Struct		Os resultados retornados.
description	String	logstash_name	O nome da instância.

O objeto Result também contém os seguintes parâmetros.

Parâmetro	Tipo	Exemplo	Descrição
instanceId	String	ls-cn-n6w1o5jq****	O ID da instância.
description	String	ls-cn-abc	O nome da instância.
nodeAmount	Integer	2	A quantidade de nós de dados.
paymentType	String	postpaid	O método de faturamento da instância. Valores válidos: prepaid (assinatura) e postpaid (pagamento conforme o uso).
status	String	active	O status da instância. Quatro status são suportados: normal (active), effective (activating), frozen (inactive) e invalid (invalid).
esVersion	String	6.7.0_with_X-Pack	A versão da instância.
createdAt	String	2018-07-13T03:58:07.253Z	O horário de criação da instância.
updatedAt	String	2018-07-13T03:58:07.253Z	O horário da última atualização da instância.
nodeSpec			A configuração do nó.
└spec	String	logstash.n4.small	A especificação do nó.
└disk	Integer	40	O tamanho do disco rígido do nó.
networkConfig			A configuração de rede.
└type	String	vpc	O tipo de rede. Atualmente, apenas Virtual Private Cloud (VPC) é suportada.
└vpcId	String	vpc-abc	O ID da VPC.
└vswitchId	String	vsw-abc	O ID do vSwitch.
vsArea	String	cn-hangzhou-*	A zona onde o cluster reside.
domainList			Os nomes de domínio retornados.
└domain	String	ls-cn-abc.logstash.aliyuncs.com	O endpoint de rede privada da instância.
└port	Integer	7001	O número da porta usada para conectar ao banco de dados.

Nota

└ indica um subparâmetro. Para mais informações sobre outros parâmetros, consulte

ListLogstash

.

Exemplos

Exemplos de requisições

PATCH /openapi/logstashes/ls-cn-n6w1o5jq****/description HTTP/1.1
common request header
{
    "description": "logstash_name"
}

Exemplos de respostas de sucesso

Sintaxe JSON

{
    "Result": {
        "instanceId": "ls-cn-n6w1o5jq****",
        "version": "6.7.0_with_X-Pack",
        "description": "logstash_name",
        "nodeAmount": 1,
        "paymentType": "postpaid",
        "status": "active",
        "enablePublic": false,
        "nodeSpec": {
            "spec": "elasticsearch.sn1ne.large",
            "disk": 50,
            "diskType": "cloud_ssd"
        },
        "networkConfig": {
            "vpcId": "vpc-bp16k1dvzxtmagcva****",
            "vswitchId": "vsw-bp1k4ec6s7sjdbudw****",
            "vsArea": "cn-hangzhou-i",
            "type": "vpc"
        },
        "createdAt": "2020-05-27T01:30:15.947Z",
        "updatedAt": "2020-07-08T02:38:47.137Z",
        "commodityCode": "elasticsearch_logstash_post",
        "extendConfigs": [],
        "endTime": 4749897600000,
        "clusterTasks": [],
        "resourceGroupId": "rg-acfm2h5vbzd****",
        "zoneCount": 1,
        "protocol": "HTTP",
        "zoneInfos": [
            {
                "zoneId": "cn-hangzhou-i",
                "status": "NORMAL"
            }
        ],
        "instanceType": "logstash",
        "inited": true,
        "tags": [],
        "config": {
            "xpack.monitoring.elasticsearch.username": "elastic",
            "xpack.monitoring.enabled": "true",
            "slowlog.threshold.debug": "500ms",
            "xpack.monitoring.elasticsearch.password": "Elasti****",
            "xpack.monitoring.elasticsearch.hosts": "[\"http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200\"]",
            "slowlog.threshold.warn": "2s",
            "slowlog.threshold.info": "1s",
            "slowlog.threshold.trace": "100ms"
        },
        "endpointList": [
            {
                "host": "172.16.**.**",
                "port": 9600,
                "zoneId": "cn-hangzhou-i"
            }
        ]
    },
    "RequestId": "C3845099-3D0E-4D2B-9D62-F16019EE****"
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	InstanceNotFound	The instanceId provided does not exist.	Mensagem de erro retornada porque a instância não foi encontrada. Verifique o status da instância.

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