Deze pagina is nog niet beschikbaar in uw eigen taal. We werken er hard aan om meer taalversies toe te voegen. Bedankt voor uw steun.

Modifying Instance Information

Updated on 2022-09-14 GMT+08:00

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.

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

Instance description.

The description can contain a maximum of 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.

retention_policy

No

Boolean

ACL.

Response Parameters

None

Example Requests

Modifying the name and description of an 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.

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback