Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getCloudPostgresqlUserList

Prev Next

Available in VPC

View Cloud DB for PostgreSQL DB User list.

Commands

The text of the command is as follows:

ncloud vpostgresql getCloudPostgresqlUserList [regionCode] [cloudPostgresqlInstanceNo] [output]

Parameter

The following is a description on parameters.

Parameter Type Requirement status Description Restrictions
regionCode String N Region code
- regionCode can be obtained via the getRegionList action
- Default: selects the first region of the getRegionList search results
-
cloudPostgresqlInstanceNo String Y Cloud DB for PostgreSQL instance number
- cloudPostgresqlInstanceNo can be obtained via the getCloudPostgresqlInstanceList action
-
output String N Format type of the response result
- options: xml | json
- default: json
-

Responses

Response data type

  • CloudPostgresqlUserList type
CloudPostgresqlUserList extends CommonResponse Description
private Integer totalRows; Total number of items viewed
private List<CloudPostgresqlUser> cloudPostgresqlUserList = new ArrayList<>(); Cloud DB for PostgreSQL DB user list
  • CloudPostgresqlUser type
CloudPostgresqlUser Description
private String userName; DB User ID
private String clientCidr; Client CIDR
private Boolean isReplicationRole; Replication role status

Examples

Describes examples of recalls and responses.

Recall examples

The following are examples of recalls.

ncloud vpostgresql getCloudPostgresqlUserList --regionCode KR --cloudPostgresqlInstanceNo ****890

Response examples

The following are examples of responses.

If the response shows that format type (output) is json

{
  "getCloudPostgresqlUserListResponse": {
    "requestId": "d733e677-ad69-4cbe-8351-711d0e0124bc",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudPostgresqlUserList": [
      {
        "userName": "testuser",
        "clientCidr": "0.0.0.0/0",
        "isReplicationRole": false
      }
    ]
  }
}

If the response shows that format type (output) is xml

<getCloudPostgresqlUserListResponse>
  <requestId>d733e677-ad69-4cbe-8351-711d0e0124bc</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudPostgresqlUserList>
    <cloudPostgresqlUser>
      <userName>testuser</userName>
      <clientCidr>0.0.0.0/0</clientCidr>
      <isReplicationRole>false</isReplicationRole>
    </cloudPostgresqlUser>
  </cloudPostgresqlUserList>
</getCloudPostgresqlUserListResponse>