getCloudMongoDbUserList

Prev Next

VPC環境で利用できます。

Cloud DB for MongoDBインスタンスの DB Userリストを照会します。

リクエスト

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

メソッド URI
GET, POST /getCloudMongoDbUserList

リクエストヘッダ

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

リクエストパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional 照会対象の Cloud DB for MongoDBインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudMongoDbInstanceNo String Required Cloud DB for MongoDBインスタンス番号
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vmongodb/v2/getCloudMongoDbUserList
?regionCode=KR
&cloudMongoDbInstanceNo=2512****
&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}'

レスポンス

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

レスポンスボディ

レスポンスボディの詳細は、CloudMongoDbUserListをご参照ください。

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

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

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

  • responseFormetType=jsonの場合

    {
        "getCloudMongoDbUserListResponse": {
            "totalRows": 1,
            "cloudMongoDbUserList": [
                {
                    "userName": "user000",
                    "databaseName": "db000",
                    "authority": "READ"
                }
            ],
            "requestId": "ca331f33-****-****-****-a46e4afd3113",
            "returnCode": "0",
            "returnMessage": "success"
        }
    }
    
  • responseFormetType=xml(デフォルト)の場合

    <?xml version="1.0" encoding="UTF-8"?>
    <getCloudMongoDbUserListResponse>
        <requestId>ca331f33-****-****-****-a46e4afd3113</requestId>
        <returnCode>0</returnCode>
        <returnMessage>success</returnMessage>
        <totalRows>1</totalRows>
        <cloudMongoDbUserList>
            <cloudMongoDbUser>
                <userName>user000</userName>
                <databaseName>db000</databaseName>
                <authority>READ</authority>
            </cloudMongoDbUser>
        </cloudMongoDbUserList>
    </getCloudMongoDbUserListResponse>