getFabricClusterList

Prev Next

Available in VPC

Overview

Get the list of Fabric clusters.

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String - Region code
Determine the Region in which the Fabric cluster list will be queried.
regionCode can be obtained through the getRegionList action.
Default: Select the first Region of the getRegionList query result.
fabricClusterPoolNo No String Filter by the Fabric cluster pool number.
fabricClusterPoolNo can be obtained through the getFabricClusterPoolList action.
fabricClusterPoolName No String Filter by Fabric cluster pool name.
fabricClusterNoList No List<String> - Fabric cluster number list
Search by filtering with the Fabric cluster number.
fabricClusterNo can be obtained through the getFabricClusterList action.
Example: --fabricClusterNoList 123 124
fabricClusterName No String Filter by Fabric cluster name.
zoneCode No String - Zone code
Search by filtering with the zone code.
zoneCode can be obtained through the getZoneList action.
vpcNo No String - VPC number
Search by filtering with the VPC number.
vpcNo can be obtained through the getVpcList action.
serverInstanceNo No String Filter by the server instance number.
pageNo No Integer - Page numbers in paged results
The results can be paged using pageNo and pageSize.
pageSize Conditional Integer - Size of each page to display when paging
The results can be paged using pageNo and pageSize.
Required when entering pageNo.
sortedBy No String - Sort target
Results can be sorted by the Fabric cluster number, Fabric cluster pool code, or zone code.
Options: fabricClusterNo | fabricClusterPoolCode | zoneCode
sortingOrder No String - Sort order
Set ascending/descending sorting when using sortedBy.
Options: ASC (ascending) | DESC (descending)
Default: ASC
output No String Response result's format type
  • Options: xml | json
  • Default: json

Response

Response data type

  • getFabricClusterList type
getFabricClusterList extends CommonResponse
private Integer totalRows;
private List<FabricCluster> fabricClusterList = new ArrayList<>();
FabricCluster
private String fabricClusterNo;
private String fabricClusterName;
private CommonCode fabricClusterStatus;
private String fabricClusterDescription;
private String regionCode;
private String zoneCode;
private String vpcNo;
private String fabricClusterPoolNo;
private String fabricClusterPoolName;
private String fabricClusterPoolCode;
private Date createDate;
private Long serverCount;
private List<FabricClusterServerInstance> fabricClusterServerInstanceList;

Examples

Request example

ncloud vserver getFabricClusterList --regionCode KR --zoneCode KR-1 --vpcNo ***84 --fabricClusterNoList 13** --pageNo 1 --pageSize 10

Response example

{
  "getFabricClusterListResponse": {
    "totalRows": 1,
    "fabricClusterList": [
      {
        "fabricClusterNo": "13**",
        "fabricClusterName": "test-***",
        "fabricClusterStatus": {
          "code": "RUN",
          "codeName": "Running"
        },
        "regionCode": "KR",
        "zoneCode": "KR-1",
        "vpcNo": "***84",
        "fabricClusterPoolNo": "***01",
        "fabricClusterPoolName": "test-***",
        "fabricClusterPoolCode": "test-***",
        "createDate": "2025-12-12T13:36:17+0900",
        "serverCount": 5
      }
    ],
    "requestId": "9b0ed68f-b044-4fd8-b138-22397fba64df",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

<getFabricClusterListResponse>
    <requestId>9b0ed68f-b044-4fd8-b138-22397fba64df</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
    <totalRows>1</totalRows>
    <fabricClusterList>
        <fabricCluster>
            <fabricClusterNo>13**</fabricClusterNo>
            <fabricClusterName>test-***</fabricClusterName>
            <fabricClusterStatus>
                <code>RUN</code>
                <codeName>Running</codeName>
            </fabricClusterStatus>
            <regionCode>KR</regionCode>
            <zoneCode>KR-1</zoneCode>
            <vpcNo>***84</vpcNo>
            <fabricClusterPoolNo>***01</fabricClusterPoolNo>
            <fabricClusterPoolName>test-***</fabricClusterPoolName>
            <fabricClusterPoolCode>test-***</fabricClusterPoolCode>
            <createDate>2025-12-12T13:36:17+0900</createDate>
            <serverCount>5</serverCount>
        </fabricCluster>
    </fabricClusterList>
</getFabricClusterListResponse>