Quota Policyの作成

Prev Next

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

Quota Policy(利用限度ポリシー)を作成します。

リクエスト

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

メソッド URI
POST /open-api/v1/policy

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
organizationGroupNoList Array Optional 適用アカウントグループ番号リスト
policyDesc String Required ポリシーの説明
  • 1~100文字
policyName String Required ポリシー名
  • 英数字、記号の「-」、「_」、「.」を組み合わせて3~50文字以内で入力
  • 先頭文字は英字または数字のみ使用
resourceQuotaList Array Required リソースの利用限度

resourceQuotaList

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

フィールド タイプ 必須の有無 説明
regionNo Integer Required リージョン番号
resourceDetailList Array Required リソースタイプの利用限度
  • リソースタイプ区分がない場合、空の値[]を表示
resourceRestrictCount Integer Required リソースの利用限度
  • 最大値以内で入力
resourceTypeCode String Required リソースコード
参考

リソースの利用限度は、NAVERクラウドプラットフォームの Service Quotaサービスを通じて照会できます。限度の照会は NAVERクラウドプラットフォームコンソールで行えます。照会方法の詳細は、Service Quotaご利用ガイドをご参照ください。

resourceDetailList

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

フィールド タイプ 必須の有無 説明
generationCode String Optional 世代区分コード
productRestrictCount Integer Optional リソースの利用限度
productTypeCode String Optional リソースのタイプコード
productTypeDetailCode String Optional リソースの詳細タイプコード

リクエスト例

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

curl --location --request POST 'https://organization.apigw.ntruss.com/open-api/v1/policy' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "organizationGroupNoList": [
        1447
    ],
    "policyDesc": "NewPolicyO4 Description",
    "policyName": "NewPolicyO4",
    "resourceQuotaList": [
        {
            "regionNo": 1,
            "resourceTypeCode": "VSVR",
            "resourceRestrictCount": 30,
            "resourceDetailList": [
                {
                    "generationCode": "G2",
                    "productRestrictCount": 20,
                    "productTypeCode": "STAND",
                    "productTypeDetailCode": "STAND"
                }
            ]
        }
    ]
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
policyNo String - ポリシー番号

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

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

レスポンス例

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

{
    "policyNo": 4944
}