Help Center/ Distributed Message Service for Kafka/ API Reference/ APIs V2 (Recommended)/ Lifecycle Management/ Modifying Instance Information
Updated on 2022-09-15 GMT+08:00
View PDF

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.

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 starts with a letter, consists of 4 to 64 characters, and can contain only letters, digits, underscores (_), and hyphens (-).

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

maintain_begin

No

String

Time at which the maintenance time window starts. The format is HH:mm:ss.

  • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window.

  • The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00:00.

  • The start time and end time must be set in pairs. If the start time is left blank, the end time must also be left blank. In this case, the system automatically sets the start time to 02:00:00.

maintain_end

No

String

Time at which the maintenance time window ends. The format is HH:mm:ss.

  • The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window.

  • The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.

  • The start time and end time must be set in pairs. If the end time is left blank, the start time is also left blank. In this case, the system automatically sets the end time to 06:00:00.

security_group_id

No

String

Security group ID.

retention_policy

No

String

Capacity threshold policy. Options:

  • produce_reject: New messages cannot be created.

  • time_base: The earliest messages are deleted.

enterprise_project_id

No

String

Enterprise project.

Response Parameters

None

Example Requests

  • Modifying the name and description of an instance.

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

{
  "name" : "kafka001",
  "description" : "kafka description"
}

  • Modifying the name, description, and maintenance time window of an instance.

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

{
  "name" : "dms002",
  "description" : "instance description",
  "maintain_begin" : "02:00:00",
  "maintain_end" : "06:00:00"
}

  • Changing the capacity threshold policy.

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

{
  "retention_policy" : "time_base"
}

Example Responses

None

Status Codes

Status Code

Description

204

The instance information is modified successfully.

Error Codes

See Error Codes.

Parent topic: Lifecycle Management