Changing an Instance Name (a V3 API)

This API is used to change the name of an instance.

None

For details, see Calling APIs.

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ddm:instance:updateName	Write	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	ddm:instance:modify	-

PUT /v3/{project_id}/instances/{instance_id}/name

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A
instance_id	Yes	String	Definition Instance ID, which uniquely identifies an instance. Constraints N/A Range The value contains 36 characters with a suffix of in09. Only letters and digits are allowed. Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Instance name Constraints The name can include 4 to 64 characters. The name must start with a letter. The name can contain only letters, digits, underscores (_), and hyphens (-). Range N/A Default Value N/A

Changing an instance name

PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein09/name

{
  "name" : "ddm-test"
}

**Table 4** Response body parameters
Parameter	Type	Description
job_id	String	Definition Workflow ID. Range N/A

Normal response example

{
  "job_id" : "0b063c71-364f-4012-95c9-576dfedf350"
}

For details, see Error Codes.

Parent topic: DDM Instances

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.