Quota Policyの作成

印刷する
共有
Twitter
Linkedin
Facebook
Email
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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	リソースの利用限度リソースタイプリストの照会レスポンスの`maxProductRestrictCount`以内で入力
`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
}

この記事は役に立ちましたか?

リクエスト
レスポンス

タグ

Organization