ModifyInstanceName
Renames an ApsaraMQ for Kafka instance. Call this operation to update the display name of a deployed instance.
Debugging
OpenAPI Explorer automatically calculates the signature value. We recommend that you call this operation in OpenAPI Explorer, which dynamically generates sample code for different SDKs.
Authorization information
The following table shows the authorization information for this API operation. Use the Action policy element to grant a Resource Access Management (RAM) user or RAM role the permission to call this operation.
| Column | Description |
|---|---|
| Operation | The value for the Action element to specify the operation on a resource. |
| Access level | The access level of the operation. Valid values: read, write, and list. |
| Resource type | The type of resource that the operation acts on. Required resource types are highlighted. |
| Condition key | The condition key defined by the cloud service. |
| Associated operation | Other operations that the RAM user or RAM role must also have permission to perform. |
| Operation | Access level | Resource type | Condition key | Associated operation |
| alikafka:UpdateInstance | Write | Instance acs:alikafka:{#regionId}:{#accountId}:{#InstanceId} | None | None |
Request parameters
| Parameter | Type | Required | Description | Example |
| InstanceId | string | Yes | The instance ID. | alikafka_post-cn-v0h1fgs2\*\*\*\* |
| RegionId | string | Yes | The region ID of the instance. | cn-hangzhou |
| InstanceName | string | Yes | The instance name. The name must be 3 to 64 characters in length and can contain only letters, digits, hyphens (-), and underscores (\_). Names longer than 64 characters are automatically truncated. | dev-test |
Response parameters
| Parameter | Type | Description | Example |
| Code | integer | The response code. 200 indicates success. | 200 |
| Message | string | The response message. | operation success. |
| RequestId | string | The request ID. | 06084011-E093-46F3-A51F-4B19A8AD\*\*\*\* |
| Success | boolean | Indicates whether the request is successful. | true |
Examples
Sample success responses
JSON format
{
"Code": 200,
"Message": "operation success.",
"RequestId": "06084011-E093-46F3-A51F-4B19A8AD****",
"Success": true
}Error codes
For a list of error codes, see Common error codes.