Jump to

• Request
• Response
• Examples

View Resource Quotas for an Account

get

/metering/api/v1/checkQuota/{accountId}

Retrieve resource quotas for all service entitlements in a given account.

Request

Path Parameters

• accountId: string
  Account name, starts with cacct.

Query Parameters

• resources: string
  Resources encode resourceName, quantity and usage source to be used in quota check.
• serviceName: string
  Service name

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.com.oracle.oracloud.metering.checkquota+json

200 Response

Success

Body ()

Root Schema : CheckQuota

Type: object

Title: CheckQuota

Show Source

• cloudCreditBalance(optional): array cloudCreditBalance
• isAllowed(optional): boolean
• resourceBalance(optional): array resourceBalance
• violationType(optional): string

{
    "type":"object",
    "title":"CheckQuota",
    "properties":{
        "isAllowed":{
            "description":"",
            "type":"boolean"
        },
        "violationType":{
            "description":"",
            "type":"string"
        },
        "cloudCreditBalance":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_CreditBalance"
                }
            }
        },
        "resourceBalance":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_ResourceQuotaBalance"
                }
            }
        }
    },
    "description":""
}

Nested Schema : cloudCreditBalance

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_CreditBalance"
        }
    }
}

Nested Schema : resourceBalance

Type: array

Show Source

• Array of: array items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/json_ResourceQuotaBalance"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object CreditBalance
  Title: CreditBalance

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_CreditBalance"
    }
}

Nested Schema : CreditBalance

Type: object

Title: CreditBalance

Show Source

• balance(optional): number
• CCType(optional): string
• dependency(optional): boolean
• purchaseAmount(optional): number

{
    "type":"object",
    "title":"CreditBalance",
    "properties":{
        "CCType":{
            "description":"",
            "type":"string"
        },
        "purchaseAmount":{
            "description":"",
            "type":"number"
        },
        "balance":{
            "description":"",
            "type":"number"
        },
        "dependency":{
            "description":"",
            "type":"boolean"
        }
    },
    "description":""
}

Nested Schema : items

Type: array

Show Source

• Array of: object ResourceQuotaBalance
  Title: ResourceQuotaBalance

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/json_ResourceQuotaBalance"
    }
}

Nested Schema : ResourceQuotaBalance

Type: object

Title: ResourceQuotaBalance

Show Source

• affectedResource(optional): string
• balance(optional): number
• dependency(optional): boolean
• inOverage(optional): boolean
• isAllowed(optional): boolean
• limit(optional): number
• name(optional): string
• purchasedLimit(optional): number
• service(optional): string

{
    "type":"object",
    "title":"ResourceQuotaBalance",
    "properties":{
        "name":{
            "description":"",
            "type":"string"
        },
        "service":{
            "description":"",
            "type":"string"
        },
        "isAllowed":{
            "description":"",
            "type":"boolean"
        },
        "limit":{
            "description":"",
            "type":"number"
        },
        "balance":{
            "description":"",
            "type":"number"
        },
        "dependency":{
            "description":"",
            "type":"boolean"
        },
        "affectedResource":{
            "description":"",
            "type":"string"
        },
        "inOverage":{
            "description":"",
            "type":"boolean"
        },
        "purchasedLimit":{
            "description":"",
            "type":"number"
        }
    },
    "description":""
}

Default Response

Unexpected error.

Back to Top

Examples

These APIs are deprecated. See Cost Analysis Overview, Using the API for more information on how to track and optimize your Oracle Cloud Infrastructure spending. See the Deprecated Notices (Endpoints) to see if there is a replacement endpoint.

Back to Top