doc-exports/docs/dms_rocketmq/api-ref/UpdateInstance.html

Modifying Instance Information

Function

This API is used to modify instance information.

URI

PUT /v2/{project_id}/instances/{instance_id}

Table 1 Path Parameters

Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
instance_id	Yes	String	Definition Instance ID. You can call the API for querying all instances to obtain the instance ID. The instance ID is in the response body. Constraints N/A Range N/A Default Value N/A

Request Parameters

Table 2 Request body parameters

Parameter	Mandatory	Type	Description
name	No	String	Definition Instance name. Constraints An instance name consists of 4 to 64 characters including letters, digits, and hyphens (-) and must start with a letter. Range N/A Default Value N/A
description	No	String	Definition Description of an instance. Constraints 0–1024 characters. The backslash (\) and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character (\) before the characters, for example, *\\* and \". Range N/A Default Value N/A
security_group_id	No	String	Definition Security group ID. You can call the API for querying security groups to obtain the security group ID. The security group ID is in the response body. For details, see Virtual Private Cloud API Reference. Constraints N/A Range N/A Default Value N/A
enable_acl	No	Boolean	Definition Whether to enable ACL. Constraints N/A Range true: Yes false: No Default Value N/A
enable_publicip	No	Boolean	Definition Whether to enable public access. Constraints N/A Range true: Yes false: No Default Value N/A
publicip_id	No	String	Definition ID of the EIP bound to the instance. Constraints Use commas (,) to separate multiple EIP IDs. This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true). Range N/A Default Value N/A
enterprise_project_id	No	String	Definition Enterprise project. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 204

Instance information modified successfully.

None

Example Requests

Modifying the name and description of a RocketMQ instance

PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}

{
  "name" : "rocketmq001",
  "description" : "RocketMQ description"
}

Example Responses

None

Status Codes

Status Code	Description
204	Instance information modified successfully.

Error Codes

See Error Codes.

Parent topic: Lifecycle Management