getCloudPostgresqlDatabaseList

Prev Next

Available in VPC

Views the list of Cloud DB for PostgreSQL database.

Commands

The text of the command is as follows:

ncloud vpostgresql getCloudPostgresqlDatabaseList [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

  • CloudPostgresqlDatabaseList type
CloudPostgresqlDatabaseList extends CommonResponse Description
private Integer totalRows; Total number of items viewed
private List<CloudPostgresqlDatabase> cloudPostgresqlDatabaseList = new ArrayList<>(); Cloud DB for PostgreSQL database list
  • CloudPostgresqlDatabase type
CloudPostgresqlDatabase Description
private String databaseName; Database name
private String owner; User ID of the database owner

Examples

Describes examples of recalls and responses.

Recall examples

The following are examples of recalls.

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

Response examples

The following are examples of responses.

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

{
  "getCloudPostgresqlDatabaseListResponse": {
    "requestId": "32993542-96c8-4899-91d8-3a273960b79c",
    "returnCode": 0,
    "returnMessage": "success",
    "totalRows": 1,
    "cloudPostgresqlDatabaseList": [
      {
        "databaseName": "pgtest",
        "owner": "testuser"
      }
    ]
  }
}

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

<getCloudPostgresqlDatabaseListResponse>
  <requestId>32993542-96c8-4899-91d8-3a273960b79c</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <cloudPostgresqlDatabaseList>
    <cloudPostgresqlDatabase>
      <databaseName>pgtest</databaseName>
      <owner>testuser</owner>
    </cloudPostgresqlDatabase>
  </cloudPostgresqlDatabaseList>
</getCloudPostgresqlDatabaseListResponse>