changeCloudMongoDbUserList

Prev Next

Available in VPC

Edit the DB user's information registered in a Cloud DB for MongoDB instance.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET, POST /changeCloudMongoDbUserList

Request headers

For headers common to all Cloud DB for MongoDB (VPC) APIs, see Cloud DB for MongoDB (VPC) request headers.

Request parameter

The following describes the parameters.

Field Type Required Description
regionCode String Optional Region code of the Cloud DB for MongoDB instance whose DB user information you want to edit
  • Check through getRegionList
  • First Region of the getRegionList query result (default)
cloudMongoDbInstanceNo String Required Instance number of Cloud DB for MongoDB
cloudMongoDbUserList.N.userName List<String> Required List of user IDs whose DB user information you want to edit
  • Check through getCloudMongoDbUserList
  • 4 to 16 characters, including English letters, numbers, and special character "_", and must begin with an English letter
  • Up to 10 can be entered
  • <E.g.>cloudMongoDbUserList.1.userName=user1&cloudMongoDbUserList.2.userName=user2
cloudMongoDbUserList.N.databaseName List<String> Required List of Cloud DB for MongoDB DB names whose DB user information you want to edit
  • Check through getCloudMongoDbUserList
  • 4 to 30 characters, including English letters, numbers, and special character "_", and must begin with an English letter
  • <E.g.>cloudMongoDbUserList.1.databaseName=db001&cloudMongoDbUserList.2.databaseName=db002
cloudMongoDbUserList.N.password List<String> Optional DB user account password to change to
  • Enter between 8 and 20 characters containing at least one English letter, number, and special character
  • Special characters ` " ' \ / & + and spaces can't be used
  • <E.g.> cloudMongoDbUserList.1.password=test123!@#&cloudMongoDbUserList.2.password=test234@#$
cloudMongoDbUserList.N.authority List<String> Optional List of DB user permissions to change to
  • READ | READ_WRITE
    • READ: data query only
    • READ_WRITE: data entry, query, modification, and change available
responseFormatType String Optional Format of the response result
  • xml (default) | json

Request example

The following is a sample request.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmongodb/v2/changeCloudMongoDbUserList
?regionCode=KR
&cloudMongoDbInstanceNo=2512****
&cloudMongoDbUserList.1.userName=user000
&cloudMongoDbUserList.1.password=********
&cloudMongoDbUserList.1.databaseName=mongo002
&cloudMongoDbUserList.1.authority=READ_WRITE
&responseFormatType=json'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response status codes

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

The following is a sample response.

  • If responseFormetType=json

    {
        "changeCloudMongoDbUserListResponse": {
            "requestId": "22843dbd-****-****-****-295b7280c5ca",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • If responseFormetType=xml (default)

    <?xml version="1.0" encoding="UTF-8"?>
    <exportDbServerLogToObjectStorageResponse>
        <requestId>22843dbd-****-****-****-295b7280c5ca</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
    </exportDbServerLogToObjectStorageResponse>