リソース利用限度の照会

Prev Next

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

アカウントに適用されたリソース別利用限度を照会します。

リクエスト

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

メソッド URI
GET /open-api/v1/policy/allotment/{memberNo}/{regionNo}

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
memberNo Integer Required アカウントの会員番号
regionNo String Required リージョン番号

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
resourceTypeCode String - リソースコード
resourceName String - リソース名
customResourceName String - リソース名
  • 通常はresourceNameと同じ
  • 一部リソースの場合、resourceNameとは違って階層情報を含む
lowerResourceName String - 下位リソース名
resourceCategoryTypeCode String - リソースのカテゴリコード
resourceQuotaDetailConfigYn String - リソースの詳細設定は必要かどうか
  • Y | N
    • Y: 必要
    • N: 必要ない
sortOrder Integer - リストのソート順
useYn String - リソースを使用するかどうか
  • Y | N
    • Y: 使用可能
    • N: 使用不可
exposureYn String - リソースを表示するかどうか
  • Y | N
    • Y: 表示
    • N: 非表示
restrictionUnitCode String - 利用限度の単位コード
restrictionUnitDescription String - 利用限度単位コードの説明
resourceQuotaList Array - リソースの利用限度
resourceQuotaDetailList Array - リソースタイプの利用限度
  • resourceQuotaDetailConfigYnがNの場合、空の値[]を表示

resourceQuotaList

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

フィールド タイプ 必須の有無 説明
policyNo String - ポリシー番号
resourceQuotaSequence String - 利用限度のシリアル番号
regionNo String - リージョン番号
resourceTypeCode String - リソースコード
restrictionCount Integer - 利用限度

resourceQuotaDetailList

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

フィールド タイプ 必須の有無 説明
policyNo String - ポリシー番号
resourceQuotaSequence String - 利用限度のシリアル番号
regionNo String - リージョン番号
resourceTypeCode String - リソースコード
productTypeCodeName String - リソースタイプ
productTypeDetailCodeName String - リソースの詳細タイプ
generationCode String - 世代区分コード
  • サーバ以外のリソースは-と表示
restrictionCount Integer - 利用限度

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

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

レスポンス例

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

[
    {
        "resourceTypeCode": "SVR",
        "resourceName": "Server",
        "customResourceName": "Server",
        "lowerResourceName": null,
        "resourceCategoryTypeCode": "COMPUTE",
        "resourceQuotaDetailConfigYn": "Y",
        "sortOrder": 1,
        "useYn": "Y",
        "exposureYn": "Y",
        "restrictionUnitCode": "COUNT",
        "restrictionUnitDescription": "Server作成数",
        "resourceQuotaList": [
            {
                "policyNo": "1",
                "resourceQuotaSequence": "18",
                "regionNo": "1",
                "resourceTypeCode": "SVR",
                "restrictionCount": 50
            }
        ],
        "resourceQuotaDetailList": [
            {
                "policyNo": "1",
                "resourceQuotaSequence": "18",
                "regionNo": "1",
                "resourceTypeCode": "SVR",
                "productTypeCodeName": "BareMetal",
                "productTypeDetailCodeName": "BareMetal",
                "generationCode": "G1",
                "restrictionCount": 5
            },
            {
                "policyNo": "1",
                "resourceQuotaSequence": "18",
                "regionNo": "1",
                "resourceTypeCode": "SVR",
                "productTypeCodeName": "CPU",
                "productTypeDetailCodeName": "CPU",
                "generationCode": "G1",
                "restrictionCount": 5
            }
            ...
        ]
    },
    {
        "resourceTypeCode": "PBLIP",
        "resourceName": "Public IP",
        "customResourceName": "Public IP",
        "lowerResourceName": null,
        "resourceCategoryTypeCode": "COMPUTE",
        "resourceQuotaDetailConfigYn": "N",
        "sortOrder": 12,
        "useYn": "Y",
        "exposureYn": "Y",
        "restrictionUnitCode": "REL_COUNT",
        "restrictionUnitDescription": "Public IPアドレス作成数",
        "resourceQuotaList": [
            {
                "policyNo": null,
                "resourceQuotaSequence": null,
                "regionNo": "1",
                "resourceTypeCode": "PBLIP",
                "restrictionCount": 100
            }
        ],
        "resourceQuotaDetailList": []
    },
    ...
]