Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ DDM Instances/ Modifying the Name of a DDM Instance
Updated on 2024-08-02 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

To obtain this value, see Obtaining a Project ID.

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.

You can obtain the token by calling the IAM API used to obtain a user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name of a DDM instance, which:

  • Can include 4 to 64 characters.
  • Must start with a letter.
  • Can contain only letters, digits, underscores (_), and hyphens (-).

Minimum length: 4 characters

Maximum length: 64 characters

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

name

String

DDM instance name

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

Modifying the name of a DDM instance

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" : "Server failure.",
  "errCode" : "DBS.200412"
}

Status Codes

Status Code

Description

200

OK

400

bad request

500

server error

Error Codes

For details, see Error Codes.

Parent topic: DDM Instances