リソースタイプリストの照会

Classic/VPC環境で利用できます。

Quota Policy(利用上限ポリシー)が適用可能なリソースタイプ(下位リソース)リストを照会します。

参考

リソースタイプリスト照会 APIは、リソースの詳細設定(利用上限設定)が必要な場合にのみ正常にレスポンスを返します。

リクエスト

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

メソッド	URI
GET	/open-api/v1/policy/detail/{regionNo}/{resourceTypeCode}/{infraResourceDetailTypeCode}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionNo`	Integer	Required	リージョン番号リージョンリストの照会を参照
`resourceTypeCode`	String	Required	リソースコードリソースリストの照会を参照
`infraResourceDetailTypeCode`	String	Required	サービスコードサービスタイプリストの照会を参照

リクエスト例

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

curl --location --request GET 'https://organization.apigw.ntruss.com/open-api/v1/policy/detail/1/SVR/VM' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`productTypeCode`	String	-	リソースタイプコード
`productTypeName`	String	-	リソースタイプ名
`productTypeDetailList`	Array	-	リソース詳細タイプ情報: productTypeDetailList
`generationCodeList`	Array	-	世代区分情報: generationCodeList サーバ照会時に表示

`productTypeDetailList`

productTypeDetailListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`productTypeDetailCode`	String	-	リソースの詳細タイプコード
`productTypeDetailName`	String	-	リソースの詳細タイプ名

`generationCodeList`

generationCodeListの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`generationCode`	String	-	世代区分コードリソースの詳細タイプの基準
`maxProductRestrictCount`	Integer	-	世代別の最大値

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

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

レスポンス例

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

[
  {
    "productTypeCode": "STAND",
    "productTypeName": "Standard",
    "productTypeDetailList": [
      {
        "productTypeDetailCode": "STAND",
        "productTypeDetailName": "Standard"
      }
    ],
    "generationCodeList": [
      {
        "generationCode": "G1",
        "maxProductRestrictCount": 0
      },
      {
        "generationCode": "G2",
        "maxProductRestrictCount": 0
      }
    ]
  },
  {
    "productTypeCode": "HICPU",
    "productTypeName": "High CPU",
    "productTypeDetailList": [
      {
        "productTypeDetailCode": "HICPU",
        "productTypeDetailName": "High CPU"
      }
    ],
    "generationCodeList": [
      {
        "generationCode": "G2",
        "maxProductRestrictCount": 50
      }
    ]
  },
  {
    "productTypeCode": "HIMEM",
    "productTypeName": "High Memory",
    "productTypeDetailList": [
      {
        "productTypeDetailCode": "HIMEM",
        "productTypeDetailName": "High Memory"
      }
    ],
    "generationCodeList": [
      {
        "generationCode": "G1",
        "maxProductRestrictCount": 10
      },
      {
        "generationCode": "G2",
        "maxProductRestrictCount": 10
      }
    ]
  },
  {
    "productTypeCode": "MICRO",
    "productTypeName": "Micro Server",
    "productTypeDetailList": [
      {
        "productTypeDetailCode": "MICRO",
        "productTypeDetailName": "Micro Server"
      }
    ],
    "generationCodeList": [
      {
        "generationCode": "G1",
        "maxProductRestrictCount": 1
      }
    ]
  },
  {
    "productTypeCode": "COMPT",
    "productTypeName": "Compact Server",
    "productTypeDetailList": [
      {
        "productTypeDetailCode": "COMPT",
        "productTypeDetailName": "Compact Server"
      }
    ],
    "generationCodeList": [
      {
        "generationCode": "G1",
        "maxProductRestrictCount": null
      }
    ]
  },
  {
    "productTypeCode": "GPU",
    "productTypeName": "GPU",
    "productTypeDetailList": [
      {
        "productTypeDetailCode": "V100",
        "productTypeDetailName": "V100"
      },
      {
        "productTypeDetailCode": "V100S",
        "productTypeDetailName": "V100S"
      },
      {
        "productTypeDetailCode": "P40R1",
        "productTypeDetailName": "P40R1"
      },
      {
        "productTypeDetailCode": "P40R2",
        "productTypeDetailName": "P40R2"
      }
    ],
    "generationCodeList": []
  },
  {
    "productTypeCode": "CPU",
    "productTypeName": "CPU Intensive",
    "productTypeDetailList": [
      {
        "productTypeDetailCode": "CPU",
        "productTypeDetailName": "CPU Intensive"
      }
    ],
    "generationCodeList": [
      {
        "generationCode": "G1",
        "maxProductRestrictCount": 5
      }
    ]
  }
]

Documentation Index