リソースカテゴリの照会

Prev Next

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

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
regionNo Integer Required リージョン番号

リクエスト例

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

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

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
sortOrder Integer - リストのソート順
resourceCategoryTypeCode String - リソースのカテゴリコード
resourceCategoryName String - リソースのカテゴリ名

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

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

レスポンス例

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

[
    {
        "sortOrder": 1,
        "resourceCategoryTypeCode": "COMPUTE",
        "resourceCategoryName": "Compute"
    },
    {
        "sortOrder": 2,
        "resourceCategoryTypeCode": "CONTAINERS",
        "resourceCategoryName": "Containers"
    },
    ...
]