Message Queue for Kafka
Message Queue for Kafka
Document
- Documentation
Message Queue for KafkaAPI ReferenceV1（2018-01-01）Instance managementModifyInstanceName
Copy page
Download PDFInstance management
ModifyInstanceName
Copy pageDownload PDFModifyInstanceName
Call the ModifyInstanceName API to modify the instance name.
Instructions
- The API Version of this interface is 2018-01-01.
- The call frequency limit for this interface is 20 times per second. If the frequency limit is exceeded, the error "AccountFlowLimitExceeded" will be returned.
Request parameters
Parameters | Parameter types | Required | Example value | DescriptionDescription |
InstanceID | String | Yes | kafka-**** | Instance ID. |
InstanceDescription | String | No | description | Instance description information. |
InstanceName | String | Yes | myinstance | Instance name. |
Response parameters
null
Example
Request example
POST https://kafka.volcengineapi.com/?Action=ModifyInstanceName&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"
}
Response example
{
"ResponseMetadata": {
"RequestId": "****************",
"Action": "ModifyInstanceName",
"Version": "2018-01-01",
"Service": "kafka",
"Region": "cn-beijing"
},
"Result": null
}
Last updated: 2025.10.20 15:53:30
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
