サービスタイプリストの照会

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

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

参考

サービスタイプリスト照会 APIは、リソースの詳細設定(利用上限設定)が必要な場合にのみ正常にレスポンスを返します。リソースリストの照会のレスポンス結果で、resourceQuotaDetailConfigYnがYのリソースにのみ使用してください。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://organization.apigw.ntruss.com/open-api/v1/policy/service/1/SVR' \
--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'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`infraResourceDetailTypeCode`	String	-	サービスタイプコード
`infraResourceDetailTypeName`	String	-	サービスタイプ名
`resourceQuotaDetailConfigYn`	String	-	リソースの詳細設定は必要かどうか `Y` \| `N` `Y`: 必要 `N`: 必要ない
`productTypeList`	Array	-	リソースタイプ情報: productTypeList

`productTypeList`

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

フィールド	タイプ	必須の有無	説明
`productTypeCode`	String	-	リソースタイプコード
`productTypeName`	String	-	リソースタイプ名

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

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

レスポンス例

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

[
  {
    "infraResourceDetailTypeCode": "BM",
    "infraResourceDetailTypeName": "BareMetal",
    "resourceQuotaDetailConfigYn": "Y",
    "productTypeList": [
      {
        "productTypeCode": "CPU",
        "productTypeName": "CPU Intensive"
      }
    ]
  },
  {
    "infraResourceDetailTypeCode": "VM",
    "infraResourceDetailTypeName": "VM",
    "resourceQuotaDetailConfigYn": "Y",
    "productTypeList": [
      {
        "productTypeCode": "STAND",
        "productTypeName": "Standard"
      },
      {
        "productTypeCode": "HICPU",
        "productTypeName": "High CPU"
      },
      {
        "productTypeCode": "HIMEM",
        "productTypeName": "High Memory"
      },
      {
        "productTypeCode": "MICRO",
        "productTypeName": "Micro Server"
      },
      {
        "productTypeCode": "COMPT",
        "productTypeName": "Compact Server"
      },
      {
        "productTypeCode": "GPU",
        "productTypeName": "GPU"
      },
      {
        "productTypeCode": "CPU",
        "productTypeName": "CPU Intensive"
      }
    ]
  }
]

Documentation Index