getFabricClusterList

Prev Next

VPC環境で利用できます。

Fabric Clusterリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET | POST /vserver/v2/getFabricClusterList
参考

ガイドは GETメソッドを基準に説明します。POSTメソッドの呼び出しテストは、NAVERクラウドプラットフォームコンソールの API Gatewayサービスの Swaggerで行えます。

リクエストヘッダ

Server APIで共通して使用されるヘッダの詳細は、Serverのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
fabricClusterPoolNo String Optional Fabric Cluster Pool番号で絞り込み
fabricClusterPoolName String Optional Fabric Cluster Pool名で絞り込み
fabricClusterNoList.N Array Optional Fabric Cluster番号リスト
  • Fabric Cluster番号で絞り込み
  • getFabricClusterListを参照
  • <例> fabricClusterNoList.1=123&fabricClusterNoList.2=124
fabricClusterName String Optional Fabric Cluster名で絞り込み
zoneCode String Optional ゾーンコードで絞り込み
vpcNo String Optional VPC番号で絞り込み
serverInstanceNo String Optional サーバインスタンス番号で絞り込み
pageNo Integer Optional ページ番号
  • 0~N (デフォルト: 0)
  • 最初のページ: 0または1を入力
pageSize Integer Conditional ページごとの項目数
  • 1~1000
  • pageNo入力時、必ず入力
sortedBy String Optional ソート基準
  • fabricClusterNo | fabricClusterPoolCode | zoneCode
    • fabricClusterNo: Fabric Cluster番号
    • fabricClusterPoolCode: Fabric Cluster Poolコード
    • zoneCode: ゾーンコード
sortingOrder String Optional ソート順序
  • ASC (デフォルト) | DESC
    • ASC: 昇順
    • DESC: 降順
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getFabricClusterList
?regionCode=KR
&zoneCode=KR-1
&vpcNo=***84
&fabricClusterNoList.1=13**
&pageNo=1
&pageSize=10
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
getFabricClusterListResponse Object - レスポンス結果
getFabricClusterListResponse.requestId String - リクエスト ID
  • UUID形式
getFabricClusterListResponse.returnCode String - レスポンスコード
getFabricClusterListResponse.returnMessage String - レスポンスメッセージ

レスポンスステータスコード

Server APIで共通して使用されるレスポンスステータスコードの詳細は、Serverのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "getFabricClusterListResponse": {
    "totalRows": 1,
    "fabricClusterList": [
      {
        "fabricClusterNo": "13**",
        "fabricClusterName": "test-***",
        "fabricClusterStatus": {
          "code": "RUN",
          "codeName": "運用中"
        },
        "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"
  }
}