addCloudMongoDbUserList

VPC環境で利用できます。

Cloud DB for MongoDBインスタンスに DB Userを追加します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET \| POST	/vmongodb/v2/addCloudMongoDbUserList

参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Cloud DB for MongoDB (VPC) APIで共通して使用されるヘッダの詳細は、Cloud DB for MongoDB (VPC)のリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	DB User追加対象の Cloud DB for MongoDBインスタンスのリージョンコード getRegionListを参照 `getRegionList`照会結果の最初のリージョン(デフォルト)
`cloudMongoDbInstanceNo`	String	Required	Cloud DB for MongoDBインスタンス番号 getCloudMongoDbInstanceListを参照
`cloudMongoDbUserList.N.userName`	List[String]	Required	Cloud DB for MongoDBインスタンスに追加するユーザー IDリスト英数字、記号の「_」を使用して4~16文字以内で入力、先頭文字は英字にする最大10個まで入力可能 <例> `cloudMongoDbUserList.1.userName=user1&cloudMongoDbUserList.2.userName=user2`
`cloudMongoDbUserList.N.databaseName`	List[String]	Required	DB User追加対象の Cloud DB for MongoDB名リスト英数字、記号の「_」を使用して4~30以内で入力、先頭文字は英字にする <例> `cloudMongoDbUserList.1.databaseName=db001&cloudMongoDbUserList.2.databaseName=db002`
`cloudMongoDbUserList.N.password`	List[String]	Required	DB Userアカウントパスワード英数字、記号をそれぞれ1文字以上含めて8~20文字以内で入力記号の「` " ' \ / & +」とスペースは使用不可 <例> `cloudMongoDbUserList.1.password=test123!@#&cloudMongoDbUserList.2.password=test234!@#`
`cloudMongoDbUserList.N.authority`	List[String]	Required	DB Userに付与する権限リスト `READ` \| `READ_WRITE` `READ`: データ照会のみ可能 `READ_WRITE`: データの入力、照会、更新、変更が可能 <例> `cloudMongoDbUserList.1.authority=READ&cloudMongoDbUserList.2.authority=READ_WRITE`
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスステータスコード

Cloud DB for MongoDB (VPC) APIで共通して使用されるレスポンスステータスコードの詳細は、Cloud DB for MongoDB (VPC)のレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

responseFormatType=jsonの場合

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

responseFormatType=xml(デフォルト)の場合

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