getPlacementGroupList

Prev Next

VPC環境で利用できます。

物理配置グループリストを照会します。

リクエスト

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

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionCode String Optional リージョンコード
  • getRegionListを参照
    • 照会結果の最初のリージョン(デフォルト)
placementGroupNoList.N Array Optional 物理配置グループ番号リスト
  • 物理配置グループ番号で絞り込み
  • <例> placementGroupNoList.1=1234&placementGroupNoList.2=2345
placementGroupName String Optional 物理配置グループ名で絞り込み
responseFormatType String Optional レスポンスデータの形式
  • xml(デフォルト) | json

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "getPlacementGroupListResponse": {
        "totalRows": 1,
        "placementGroupList": [
            {
                "placementGroupNo": "***61",
                "placementGroupName": "test-***",
                "placementGroupType": {
                    "code": "AA",
                    "codeName": "Anti-Affinity"
                }
            }
        ],
        "requestId": "327bfd55-2e71-4720-8c74-c99c35bfab46",
        "returnCode": "0",
        "returnMessage": "success"
    }
}