Oracle Cloud Account Metering REST API

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

Response

Supported Media Types

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

200 Response

Success

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.

Examples

cURL Command

The following example shows how to retrieve the quota (resource consumption) for a resource by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -u joe@example.com 
     -H "X-ID-TENANT-NAME:myDomain" 
     "https://itra.oraclecloud.com/metering/api/v1/checkQuota/hl1722trial?serviceName=Compute&resources=resourceName=EIPs,quantity=1" -v

Example of Request Body

There is no request body to submit with the HTTP request.

Example of Response Body

The following example shows the response body in JSON format.

{
 "isAllowed":true,
 "resourceBalance":[{
      "name":"EIPs",
		  "service":"Compute",
		  "isAllowed":true,
		  "limit":5.0,
		  "balance":0.0,
		  "purchasedLimit":5.0
		  }]
}