changeCloudPostgresqlUserList

Available in VPC

Edit the DB user's information registered in a Cloud DB for PostgreSQL instance.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET \| POST	/vpostgresql/v2/changeCloudPostgresqlUserList

Note

This guide is based on the GET method. POST method call tests can be performed through Swagger in the API Gateway service of the NAVER Cloud Platform console.

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`regionCode`	String	Optional	Region code Region code of the Cloud DB for PostgreSQL instance whose DB user information you want to edit. See getRegionList. First Region of the `getRegionList` query result (default).
`cloudPostgresqlInstanceNo`	String	Required	Cloud DB for PostgreSQL instance number See getCloudPostgresqlInstanceList.
`cloudPostgresqlUserList.N.name`	List[String]	Required	List of user IDs whose DB user information you want to edit Enter between 4 and 16 characters using a combination of English letters, numbers, and special character "_". The string must start with an English letter. Predefined roles and reserved words can't be used. Example: `cloudPostgresqlUserList.1.name=testuser1&cloudPostgresqlUserList.2.name=testuser2`
`cloudPostgresqlUserList.N.clientCidr`	List[String]	Conditional	CIDR (access control) list of clients trying to access Enter only when changing the client CIDR. At least one of the following is required: Client CIDR, password, and replication role status. 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). Example: `cloudPostgresqlUserList.1.clientCidr=0.0.0.0/0&cloudPostgresqlUserList.2.clientCidr=192.168.1.1/32`
`cloudPostgresqlUserList.N.password`	List[String]	Conditional	DB user account password Enter only when changing the password. At least one of the following is required: Client CIDR, password, and replication role status. 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. Example: `cloudPostgresqlUserList.1.password=******&cloudPostgresqlUserList.2.password=******`
`cloudPostgresqlUserList.N.isReplicationRole`	List[Boolean]	Conditional	Replication role status list `true` \| `false` Enter only when changing the replication role At least one of the following is required: Client CIDR, password, and replication role status Example: `cloudPostgresqlUserList.1.isReplicationRole=true&cloudPostgresqlUserList.N.isReplicationRole=false`
`responseFormatType`	String	Optional	Format of the response result `xml` (default) \| `json`

Request example

The request example is as follows:

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

Response

This section describes the response format.

Response status codes

For information about the HTTP status codes common to all Cloud DB for PostgreSQL (VPC) APIs, see Cloud DB for PostgreSQL (VPC) response status codes.

Response example

The response example is as follows:

If responseFormatType=json

{
    "changeCloudPostgresqlUserListResponse": {
        "requestId": "c345f9b5-****-****-****-db6f8c7f6c80",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

If responseFormatType=xml (default)

<?xml version="1.0" encoding="UTF-8"?>
<changeCloudPostgresqlUserListResponse>
    <requestId>c345f9b5-****-****-****-db6f8c7f6c80</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</changeCloudPostgresqlUserListResponse>