Updated on 2024-04-08 GMT+08:00

Modifying Instance Information

Function

This API is used to modify the name and description of an instance.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

instance_id

Yes

String

Instance ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

No

String

Instance name.

An instance name consists of 4 to 64 characters including letters, digits, and hyphens (-) and must start with a letter.

description

No

String

Description of an instance.

The description supports up to 1024 characters.

NOTE:

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 ".

security_group_id

No

String

Security group ID.

To obtain it, log in to the VPC console and view the security group ID on the security group details page.

enable_acl

No

Boolean

ACL.

enable_publicip

No

Boolean

Whether to enable public access.

publicip_id

No

String

ID of the EIP bound to the instance.

Use commas (,) to separate multiple EIP IDs.

This parameter is mandatory if public access is enabled (that is, enable_publicip is set to true).

Response Parameters

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.