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

Prev Next

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/detail/1/VSVR' \
--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 - リソースタイプ名
resourceQuotaDetailConfigYn String - リソースの詳細設定は必要かどうか
  • Y | N
    • Y: 必要
    • N: 必要ない
productTypeDetailList Array - リソースの詳細タイプ情報

productTypeDetailList

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

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

generationCodeList

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

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

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

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

レスポンス例

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

[
    {
        "productTypeCode": "STAND",
        "productTypeName": "Standard",
        "resourceQuotaDetailConfigYn": "Y",
        "productTypeDetailList": [
            {
                "productTypeDetailCode": "STAND",
                "productTypeDetailName": "Standard",
                "generationCodeList": [
                    {
                        "generationCode": "G2",
                        "maxProductRestrictCount": 50
                    },
                    {
                        "generationCode": "G3",
                        "maxProductRestrictCount": 50
                    }
                ]
            }
        ]
    },
    {
        "productTypeCode": "HICPU",
        "productTypeName": "High CPU",
        "resourceQuotaDetailConfigYn": "Y",
        "productTypeDetailList": [
            {
                "productTypeDetailCode": "HICPU",
                "productTypeDetailName": "High CPU",
                "generationCodeList": [
                    {
                        "generationCode": "G2",
                        "maxProductRestrictCount": 50
                    },
                    {
                        "generationCode": "G3",
                        "maxProductRestrictCount": 50
                    }
                ]
            }
        ]
    },
  ...
]