UpdateLogstashDescription_Elasticsearch_API文档-阿里云OpenAPI开发者门户

接口说明

调用该接口时，请注意：实例状态为生效中（activating）、失效（invalid）和冻结（inactive）时，无法修改实例名称。

当前云产品API请求速率暂未透出。

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

elasticsearch:UpdateLogstashDescription	Write	Logstash acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}	无	无

PATCH /openapi/logstashes/{InstanceId}/description HTTP/1.1
POST /openapi/logstashes/{InstanceId}/description HTTP/1.1

字段名称	字段详情
InstanceIdstring	实例 ID。示例值:ls-cn-n6w1o5jq****参考取值来源: ListInstance

字段名称	字段详情
clientTokenstring	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodyobject

RequestBody 中还需填入 description 字段，用来指定修改后的实例名称，示例如下。

{
    "description": "logstash_name"
}

字段名称	字段详情
RequestIdstring	请求 ID。示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****
Resultobject	返回结果。

Result 中还包含以下参数。

参数名称	数据类型	示例值	描述
instanceId	String	ls-cn-n6w1o5jq****	实例 ID。
description	String	ls-cn-abc	实例名称。
nodeAmount	Integer	2	实例的节点个数。
paymentType	String	postpaid	实例的付费方式。支持：prepaid（包年包月）、postpaid（按量付费）。
status	String	active	实例的状态，支持四种状态：正常（active）、生效中（activating）、冻结（inactive）和失效（invalid）。
esVersion	String	6.7.0_with_X-Pack	实例的版本。
createdAt	String	2018-07-13T03:58:07.253Z	实例的创建时间。
updatedAt	String	2018-07-13T03:58:07.253Z	实例最后更新的时间。
nodeSpec			节点的配置信息。
└spec	String	logstash.n4.small	节点规格。
└disk	Integer	40	节点的硬盘大小。
networkConfig			网络配置。
└type	String	vpc	网络类型。目前只支持专有网络 VPC（Virtual Private Cloud）。
└vpcId	String	vpc-abc	VPC ID。
└vswitchId	String	vsw-abc	虚拟交换机 ID。
vsArea	String	cn-hangzhou-*	实例所在的可用区。
domainList			域名列表。
└domain	String	ls-cn-abc.logstash.aliyuncs.com	实例分配的私网域名。
└port	Integer	7001	端口号。

说明 └表示子参数，其他参数说明请参见 ListLogstash 。

	变更时间	变更内容概要	操作
	2022-08-30	删除错误码400