getFabricClusterDetail

VPC環境で利用できます。

Fabric Clusterの詳細情報を照会します。

リクエスト

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

メソッド	URI
GET \| POST	/vserver/v2/getFabricClusterDetail

参考

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionCode`	String	Optional	リージョンコード getRegionListを参照照会結果の最初のリージョン(デフォルト)
`fabricClusterNo`	String	Required	Fabric Cluster番号 getFabricClusterListを参照
`responseFormatType`	String	Optional	レスポンスデータの形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getFabricClusterDetail
?regionCode=KR
&fabricClusterNo=13**
&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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
  "getFabricClusterDetailResponse": {
    "totalRows": 1,
    "fabricClusterList": [
      {
        "fabricClusterNo": "13**",
        "fabricClusterName": "test-***",
        "fabricClusterStatus": {
          "code": "RUN",
          "codeName": "運用中"
        },
        "fabricClusterDescription": "test",
        "regionCode": "KR",
        "zoneCode": "KR-1",
        "vpcNo": "***84",
        "fabricClusterPoolNo": "***01",
        "fabricClusterPoolName": "test-***",
        "fabricClusterPoolCode": "test-***",
        "createDate": "2025-12-12T13:36:17+0900",
        "fabricClusterServerInstanceList": [
          {
            "serverInstanceNo": "****59627",
            "serverName": "test-***",
            "serverInstanceStatus": {
              "code": "RUN",
              "codeName": "サーバ RUN状態"
            },
            "serverInstanceOperation": {
              "code": "NULL",
              "codeName": "サーバ NULL OP"
            },
            "serverInstanceStatusName": "running"
          }
        ]
      }
    ],
    "requestId": "73a0f845-f9da-4a93-a177-8c209ce58e73",
    "returnCode": "0",
    "returnMessage": "success"
  }
}