Change Instance Name
Last Updated：2021-08-30
Modify an Instance Name
Request structure
PUT /v{version}/instance/{dbInstanceId}?modifyName HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization string
{
"dbInstanceName": dbInstanceName
}Request header field
No other special header fields are available except for the common header fields.
Request Parameter
| Parameter Name | Type | Required? | Parameter Position | Description |
|---|---|---|---|---|
| version | string | Yes | URL Parameter | API version number |
| dbInstanceId | string | Yes | URL Parameter | Designated instance Id |
| dbInstanceName | string | Yes | RequestBody parameter | The instance name, which meets the following requirements: 1) It supports uppercase and lowercase letters, numbers, Chinese characters, and special characters like “-”, "", "_”, "/”, and “.” and must start with a letter； 2) It has the maximum length of 1-65 characters. |
Return header field
There are no other special header fields except for the common header field.
Return parameter
No special return parameters are available.
Request example
PUT /v1/instance/m-qNlWTz?modifyName HTTP/1.1
HOST: mongodb.bj.baidubce.com
ContentType: application/json
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-11-21T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
{
"dbInstanceName":"myMongo"
}Return example
HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
Content-Length: 0