Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getPlacementGroupList

Prev Next

VPC環境で利用できます。

概要

サーバインスタンス(VM)が属する物理配置グループのリストを照会します。

リクエスト

リクエストパラメータ

パラメータ名 必須の有無 タイプ 制約事項 説明
regionCode No String リージョンコード
物理配置グループのリストが照会されるリージョン(Region)を決定できます。
regionCodeはgetRegionListアクションを通じて取得できます。
Default:getRegionList照会結果の最初のリージョンを選択
placementGroupNoList.N No List<String> 物理配置グループ番号リスト
物理配置グループ番号でフィルタリングして検索できます。
placementGroupNoはgetPlacementGroupListアクションを通じて取得できます。
ex)--placementGroupNoList 1234 2345
placementGroupName No String 物理配置グループ名
物理配置グループ名でフィルタリングして検索できます。
output No String レスポンス結果の形式タイプ
  • Options : xml | json
  • Default : json

レスポンス

レスポンスデータタイプ

  • PlacementGroupListタイプ
PlacementGroupList extends CommonResponse
private Integer totalRows;
private List<PlacementGroup> placementGroupList = new ArrayList<>();
PlacementGroup
private String placementGroupNo;
private String placementGroupName;
private CommonCode placementGroupType;

リクエスト例

ncloud vserver getPlacementGroupList --regionCode KR --placementGroupNoList ***61 --placementGroupName test-***

レスポンス例

<getPlacementGroupListResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <placementGroupList>
    <placementGroup>
      <placementGroupNo>***61</placementGroupNo>
      <placementGroupName>test-***</placementGroupName>
      <placementGroupType>
        <code>AA</code>
        <codeName>Anti-Affinity</codeName>
      </placementGroupType>
    </placementGroup>
  </placementGroupList>
</getPlacementGroupListResponse>