Help Center/ Distributed Database Middleware/ API Reference (Kuala Lumpur Region)/ DDM Instance Management/ Modifying the Name of a DDM Instance
Updated on 2022-08-17 GMT+08:00
View PDF
Share

Modifying the Name of a DDM Instance

Function

This API is used to modify the name of a DDM instance.

Constraints

None

URI

PUT /v1/{project_id}/instances/{instance_id}/modify-name

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

instance_id

Yes

String

DDM instance ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name of a DDM instance, which:

  • Consists of 4 to 64 characters.
  • Must start with a letter.
  • Contains only letters, digits, and hyphens (-).

Minimum length: 4

Maximum length: 64

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

name

String

Name of the DDM instance

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

errCode

String

Service error code

externalMessage

String

Error message

Example Request

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}/modify-name

{
  "name" : "DDM_test_04"
}

Example Response

Status code: 200

OK

{
  "name" : "DDM_test_04"
}

Status code: 400

bad request

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status code: 500

server error

{
  "externalMessage" : "Parameter error.",
  "errCode" : "DBS.280001"
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Parent topic: DDM Instance Management