addCloudMongoDbUserList

Available in VPC

Add a DB user to 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	/vmongodb/v2/addCloudMongoDbUserList

Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`regionCode`	String	Optional	Region code of the Cloud DB for MongoDB instance whose DB user you want to add See getRegionList First Region of the `getRegionList` query result (default)
`cloudMongoDbInstanceNo`	String	Required	Instance number of Cloud DB for MongoDB See getCloudMongoDbInstanceList
`cloudMongoDbUserList.N.userName`	List[String]	Required	User ID list to add to the Cloud DB for MongoDB instance 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 to add the DB user to 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]	Required	DB user account password 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]	Required	List of permissions to grant to the DB user `READ` \| `READ_WRITE` `READ`: data query only `READ_WRITE`: data entry, query, modification, and change available <E.g.> `cloudMongoDbUserList.1.authority=READ&cloudMongoDbUserList.2.authority=READ_WRITE`
`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/addCloudMongoDbUserList
?regionCode=KR
&cloudMongoDbInstanceNo=2442****
&cloudMongoDbUserList.1.userName=user001
&cloudMongoDbUserList.1.databaseName=db001
&cloudMongoDbUserList.1.password=********
&cloudMongoDbUserList.1.authority=READ
&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 information about the HTTP status codes common to all Cloud DB for MongoDB (VPC) APIs, see Cloud DB for MongoDB (VPC) response status codes.

Response example

The following is a sample response.

If responseFormatType=json

{
    "addCloudMongoDbUserListResponse": {
        "requestId": "1d40e0fa-****-****-****-d9eccc536f7b",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

If responseFormatType=xml (default)

<?xml version="1.0" encoding="UTF-8"?>
<addCloudMongoDbUserListResponse>
    <requestId>1d40e0fa-****-****-****-d9eccc536f7b</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</addCloudMongoDbUserListResponse>