Create quota policy

Prev Next

Available in Classic and VPC

Create a quota policy.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /open-api/v1/policy

Request headers

For information about the headers common to all Organization APIs, see Organization request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
organizationGroupNoList Array Optional List of applicable account group numbers
policyDesc String Required Policy description
  • 0-100 characters
policyName String Required Policy name
  • Enter 3-50 characters by combining English letters, numbers, and special characters "-", "_", and "."
  • It must start with an English letter or a number
resourceQuotaList Array Required Resource usage limit

resourceQuotaList

The following describes resourceQuotaList.

Field Type Required Description
regionNo Integer Required Region number
resourceDetailList Array Required Resource type usage limit
  • If the resource type is not specified, it is displayed as an empty value []
resourceRestrictCount Integer Required Resource usage limist
  • Enter within the maximum limit
resourceTypeCode String Required Resource code
Note

You can check the resource usage limit through the Service Quota service of the NAVER Cloud Platform. You can check the limit in the NAVER Cloud Platform console. For more information on how to check the limit, see the Service Quota User Guide.

resourceDetailList

The following describes resourceDetailList.

Field Type Required Description
generationCode String Optional Generation classification code
productRestrictCount Integer Optional Resource usage limit
productTypeCode String Optional Resource type code
productTypeDetailCode String Optional Resource detailed type code

Request example

The request example is as follows:

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"
                }
            ]
        }
    ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
policyNo String - Policy number

Response status codes

For response status codes common to all Organization APIs, see Organization response status codes.

Response example

The response example is as follows:

{
    "policyNo": 4944
}