Docs

Message Queue for Kafka

Instance management

ModifyInstanceAttributes - Modify instance basic information

Call the ModifyInstanceAttributes API to modify the instance name, description, and other instance information.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.

Action string required Example value: ModifyInstanceAttributes

Operation to perform, value: ModifyInstanceAttributes.

Version string required Example value: 2022-05-01

API version, value: 2022-05-01.

InstanceName string No Example value: myinstance

Instance name.

InstanceDescription string No Example value: New instance

Instance description.

InstanceId string required Example value: kafka-cnngqkfgdudt****

Instance ID.

Response parameters

This interface has no unique response parameters. For more information, see the response structure.

Request example

POST /?Action=ModifyInstanceAttributes&Version=2022-05-01 HTTP/1.1​
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-cnng5ysg5vv9****",​
  "InstanceName": "DTS-all",​
  "InstanceDescription": "DTS-all"​
}​

Response example

{​
    "ResponseMetadata": {​
        "RequestId": "202302271847143C6FF96F30A58C7F0FE4",​
        "Action": "ModifyInstanceAttributes",​
        "Version": "2022-05-01",​
        "Service": "Kafka",​
        "Region": "cn-beijing"​
    },​
    "Result": null​
}​

Error code

The following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.

Status code	Error code	Error message	Specifications
400	InvalidParameter	The specified parameter is not valid.	Invalid parameter value.
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	You are not authorized. Authorize or switch accounts and try again.
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	The current instance state does not allow this operation.
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	Instance does not exist.
500	InternalError	The request failed due to some unknown error, exception or failure.	Internal error, please try again later.

Last updated: 2025.06.30 12:00:31