リソースリストの照会

印刷する
共有
Twitter
Linkedin
Facebook
Email
PDF

記事の要約

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

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

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

Quota Policy(利用限度ポリシー)が適用可能なリソースリストを照会します。

リクエスト

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

メソッド	URI
GET	/open-api/v1/policy/resource/{regionNo}/{categoryCode}

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`regionNo`	Integer	Required	リージョン番号リージョンリストの照会を参照
`categoryCode`	String	Required	リソースのカテゴリコードリソースカテゴリの照会を参照

リクエスト例

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

curl --location --request GET 'https://organization.apigw.ntruss.com/open-api/v1/policy/resource/1/COMPUTE' \
--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	-	リソース名
`includeLowerResourceYn`	String	-	下位リソースは存在するかどうか `Y` \| `N` `Y`: 存在する `N`: 存在しない
`maxResourceRestrictCount`	Integer	-	リソースの利用限度 `null`: コンソールで確認可能で、APIではサポートしない
`resourceQuotaDetailConfigYn`	String	-	リソースの詳細設定は必要かどうか `Y` \| `N` `Y`: 必要 `N`: 必要ない
`restrictionUnitCode`	String	-	利用限度の単位コード
`restrictionUnitDescription`	String	-	利用限度単位コードの説明

参考

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

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

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

レスポンス例

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

[
    {
        "resourceTypeCode": "CF",
        "resourceName": "Cloud Functions",
        "includeLowerResourceYn": "N",
        "maxResourceRestrictCount": null,
        "resourceQuotaDetailConfigYn": "N",
        "restrictionUnitCode": "BOOLEAN",
        "restrictionUnitDescription": "Subscription中かどうか"
    },
    {
        "resourceTypeCode": "PRSBN",
        "resourceName": "Private Subnet",
        "includeLowerResourceYn": "N",
        "maxResourceRestrictCount": null,
        "resourceQuotaDetailConfigYn": "N",
        "restrictionUnitCode": "COUNT",
        "restrictionUnitDescription": "Private Subnet作成数"
    },
    ...
]

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

リクエスト
レスポンス

タグ

Organization