addCloudPostgresqlUserList

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Add a DB user to a Cloud DB for PostgreSQL instance.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET, POST	/addCloudPostgresqlUserList

Request headers

For headers common to all Cloud DB for PostgreSQL (VPC) APIs, see Cloud DB for PostgreSQL (VPC) request headers.

Request parameter

The following describes the parameters.

Field	Type	Required	Description
`regionCode`	String	Optional	Region code Region code of the Cloud DB for PostgreSQL instance to add the DB user to Check through getRegionList First Region of the `getRegionList` query result (default)
`cloudPostgresqlInstanceNo`	String	Required	Cloud DB for PostgreSQL instance number Check through getCloudPostgresqlInstanceList
`cloudPostgresqlUserList.N.name`	List<String>	Required	User ID list to add to the Cloud DB for PostgreSQL instance 4 to 16 characters, including lowercase English letters, numbers, and special character "_", and must begin with an English letter Predefined roles and reserved words can't be used <E.g.> `cloudPostgresqlUserList.1.name=testuser1&cloudPostgresqlUserList.2.name=testuser2`
`cloudPostgresqlUserList.N.clientCidr`	List<String>	Required	CIDR (access control) list of clients trying to connect CIDR application method Allow access to all: 0.0.0.0/0 Allow access to specific IPs: <E.g> 192.168.1.1/32 Allow access to an IP range: <E.g.> 192.168.1.0/24 <E.g.> `cloudPostgresqlUserList.1.clientCidr=0.0.0.0/0&cloudPostgresqlUserList.2.clientCidr=192.168.1.1/32`
`cloudPostgresqlUserList.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 User ID can't be included <E.g.> `cloudPostgresqlUserList.1.password=******&cloudPostgresqlUserList.2.password=******`
`cloudPostgresqlUserList.N.isReplicationRole`	List<Boolean>	Required	Replication role status list `true` \| `false` <E.g.> `cloudPostgresqlUserList.1.isReplicationRole=true&cloudPostgresqlUserList.N.isReplicationRole=false`
`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/vpostgresql/v2/addCloudPostgresqlUserList
?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}'

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 responseFormatType=json

{
    "addCloudPostgresqlUserListResponse": {
        "requestId": "7d560df7-****-****-****-42928b27518d",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

If responseFormatType=xml (default)

<?xml version="1.0" encoding="UTF-8"?>
<addCloudPostgresqlUserListResponse>
    <requestId>7d560df7-****-****-****-42928b27518d</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</addCloudPostgresqlUserListResponse>

Was this article helpful?

What's Next

changeCloudPostgresqlUserList

Table of contents

Request
Response