addCloudMongoDbUserList
    • PDF

    addCloudMongoDbUserList

    • PDF

    Article summary

    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:

    MethodURI
    GET, POST/addCloudMongoDbUserList

    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.

    FieldTypeRequiredDescription
    regionCodeStringOptionalRegion code of the Cloud DB for MongoDB instance whose DB user you want to add
    • Check through getRegionList
    • First Region of the getRegionList query result (default)
    cloudMongoDbInstanceNoStringRequiredInstance number of Cloud DB for MongoDB
    cloudMongoDbUserList.N.userNameList<String>RequiredUser 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.databaseNameList<String>RequiredList 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.passwordList<String>RequiredDB 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.authorityList<String>RequiredList 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
    responseFormatTypeStringOptionalFormat 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 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

      {
          "addCloudMongoDbUserListResponse": {
              "requestId": "1d40e0fa-****-****-****-d9eccc536f7b",
              "returnCode": "0",
              "returnMessage": "success"
          }
      }
      
    • If responseFormetType=xml (default)

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

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.