getPlacementGroupDetail

VPC環境で利用できます。

物理配置グループの詳細情報を照会します。

リクエスト

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

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

参考

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "getPlacementGroupDetailResponse": {
        "totalRows": 1,
        "placementGroupList": [
            {
                "placementGroupNo": "***61",
                "placementGroupName": "test-***",
                "placementGroupType": {
                    "code": "AA",
                    "codeName": "Anti-Affinity"
                }
            }
        ],
        "requestId": "9971214e-0e0a-484d-bac5-4e1d41c4a192",
        "returnCode": "0",
        "returnMessage": "success"
    }
}