Modifying the Name of a DDM Instance¶

Function¶

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

None

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

**Table 2** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the 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, and hyphens (-). Minimum length: 4 characters Maximum length: 64 characters

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

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

{
  "name" : "DDM-test-04"
}

Status code: 200

{
  "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"
}

For details, see Error Codes.

last updated: 2024-12-11 13:43 UTC - commit: 0e04c4a111cf440cbe530f17da84f5c1ac074d8f