Skip to Content
Cloud Database(UDB) ModifyUDBInstanceName

Modify UDB Name - ModifyUDBInstanceName

Overview

Rename UDB Instance

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ModifyUDBInstanceName.Yes
PublicKeystringThe user’s public key can be obtained from Console Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability Zones Yes
ZonestringAvailability Zone. See Availability Zone List No
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface .No
DBIdstringInstance’s Id, this value can be obtained through DescribeUDBInstanceYes
NamestringThe new name of the instance, the length requirement is 6~63 charactersYes

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No

Example

Request Example

https://api.ucloud-global.com/?Action=ModifyUDBInstanceName &Region=cn-bj2 &DBId=udb-xxxxxx &Name=xxx-yyy

Response Example

{ "Action": "ModifyUDBInstanceNameResponse", "RetCode": 0 }