You need to enable JavaScript to run this app.
导航
ModifyInstanceDescription
最近更新时间:2022.10.18 16:24:24首次发布时间:2021.08.30 16:20:22

调用 ModifyInstanceDescription 接口修改实例描述信息。

使用说明

  • 此接口的 API Version 为 2018-01-01
  • 此接口的调用频率限制为 20 次/s,超出频率限制会报错 “AccountFlowLimitExceeded”。

请求参数

参数参数类型是否必选示例值说明
InstanceIDString必选kafka-****实例 ID。
InstanceDescriptionString必选description实例描述信息。
InstanceNameString可选myinstance实例名称。

响应参数

null

示例

请求示例

POST https://kafka.volcengineapi.com/?Action=ModifyInstanceDescription&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: kafka.volcengineapi.com
X-Date: 20210328T100802Z
Authorization: HMAC-SHA256 Credential=AK********/20210328/cn-beijing/kafka/request, SignedHeaders=x-date, Signature=********

{
  "InstanceId": "kafka-xxxxxxxx",
  "InstanceDescription": "new-describe",
  "InstanceName": "new-name"
}

响应示例

{
  "ResponseMetadata": {
    "RequestId": "****************",
    "Action": "ModifyInstanceName",
    "Version": "2018-01-01",
    "Service": "kafka",
    "Region": "cn-beijing"
  },
  "Result": null
}