changeCloudPostgresqlUserList

Prev Next

VPC環境で利用できます。

Cloud DB for PostgreSQLインスタンスに登録されている DB User情報を変更します。

リクエスト

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

メソッド URI
GET, POST /changeCloudPostgresqlUserList

リクエストヘッダ

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

リクエストパラメータ

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • DB User情報変更対象の Cloud DB for PostgreSQLインスタンスのリージョンコード
  • getRegionListを通じて確認
  • getRegionList照会結果の最初のリージョン(デフォルト)
cloudPostgresqlInstanceNo String Required Cloud DB for PostgreSQLインスタンス番号
cloudPostgresqlUserList.N.name List<String> Required DB User情報変更対象のユーザー IDリスト
  • 英字の小文字、数字、記号の「_」を使用して4~16文字以内で入力、先頭文字は英字にする
  • あらかじめ定義した roleと予約語は使用不可
  • <例> cloudPostgresqlUserList.1.name=testuser1&cloudPostgresqlUserList.2.name=testuser2
cloudPostgresqlUserList.N.clientCidr List<String> Conditional アクセスするクライアントの CIDR(アクセス制御)リスト
  • Client CIDR変更時にのみ入力
  • Client CIDR、パスワード、Replication Roleかどうかのうち、1つは必ず入力
  • CIDRの適用方法
    • すべてのアクセスを許可: 0.0.0.0/0
    • 特定の IPアドレスからのアクセスを許可: <例> 192.168.1.1/32
    • IPアドレス帯域からのアクセスを許可: <例> 192.168.1.0/24
  • <例> cloudPostgresqlUserList.1.clientCidr=0.0.0.0/0&cloudPostgresqlUserList.2.clientCidr=192.168.1.1/32
cloudPostgresqlUserList.N.password List<String> Conditional DB Userアカウントパスワード
  • パスワード変更時にのみ入力
  • Client CIDR、パスワード、Replication Roleかどうかのうち、1つは必ず入力
  • 英数字、記号をそれぞれ1文字以上含めて8~20文字以内で入力
  • 記号の「` & + \ " ' /」とスペースは使用不可
  • User IDは含めないこと
  • <例> cloudPostgresqlUserList.1.password=********&cloudPostgresqlUserList.2.password=********
cloudPostgresqlUserList.N.isReplicationRole List<Boolean> Conditional Replication Roleかどうかリスト
  • true | false
  • Replication Role変更時にのみ入力
  • Client CIDR、パスワード、Replication Roleかどうかのうち、1つは必ず入力
  • <例> cloudPostgresqlUserList.1.isReplicationRole=true&cloudPostgresqlUserList.N.isReplicationRole=false
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vpostgresql/v2/changeCloudPostgresqlUserList
?regionCode=KR
&cloudPostgresqlInstanceNo=****925
&cloudPostgresqlUserList.1.name=testuser
&cloudPostgresqlUserList.1.clientCidr=0.0.0.0/0
&cloudPostgresqlUserList.1.password=********
&cloudPostgresqlUserList.1.isReplicationRole=false'
--header 'x-ncp-apigw-timestamp: {Timestamp}' 
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

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

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

レスポンス例

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

  • responseFormatType=jsonの場合
{
    "changeCloudPostgresqlUserListResponse": {
        "requestId": "c345f9b5-****-****-****-db6f8c7f6c80",
        "returnCode": "0",
        "returnMessage": "success"
    }
}
  • responseFormatType=xml(デフォルト)の場合
<?xml version="1.0" encoding="UTF-8"?>
<changeCloudPostgresqlUserListResponse>
    <requestId>c345f9b5-****-****-****-db6f8c7f6c80</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</changeCloudPostgresqlUserListResponse>