Jump to

• Request
• Response
• Examples

View Hard and Soft Limits of a Service Resource

get

/metering/api/v1/cloudbucklimits/{accountId}/{entitlementId}

Retrieve the hard and soft limits for a resource.

Request

Path Parameters

• accountId: string
  Account name, starts with cacct.
• entitlementId: string
  Service Entitlement Id

Query Parameters

• limitType: string
  Hard or soft limt. Hard limits lead to breaches, soft to alerts.
• resourceType: string
  Resource Name.
• serviceType: string
  Service Name.

Back to Top

Response

Supported Media Types

• application/vnd.com.oracle.oraclecloud.metering.cloudbucklimits+json

200 Response

Success

Body ()

Root Schema : CloudBuckLimits

Type: object

Title: CloudBuckLimits

Encapsulates a collection of Hard and Soft Limits for a resource within a subscription.

Show Source

• canonicalLink(optional): string
• items(optional): array items

{
    "type":"object",
    "title":"CloudBuckLimits",
    "properties":{
        "canonicalLink":{
            "description":"",
            "type":"string"
        },
        "items":{
            "description":"",
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/json_CloudBuckLimit"
                }
            }
        }
    },
    "description":"Encapsulates a collection of Hard and Soft Limits for a resource within a subscription."
}

Nested Schema : items

Type: array

Show Source

• Array of: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object CloudBuckLimit
  Title: CloudBuckLimit

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

Nested Schema : CloudBuckLimit

Type: object

Title: CloudBuckLimit

Show Source

• action(optional): string
• alertLevel(optional): number
• createdBy(optional): string
• createdOn(optional): object createdOn
• entitlementId(optional): string
• id(optional): string
• limit(optional): number
• limitType(optional): string
• maxHardLimit(optional): string
• modifiedBy(optional): string
• modifiedOn(optional): object modifiedOn
• resourceName(optional): string
• serviceName(optional): string
• skuPartId(optional): string
• status(optional): string
• valueType(optional): string

{
    "type":"object",
    "title":"CloudBuckLimit",
    "properties":{
        "createdOn":{
            "description":"",
            "type":"object"
        },
        "entitlementId":{
            "description":"",
            "type":"string"
        },
        "id":{
            "description":"",
            "type":"string"
        },
        "modifiedOn":{
            "description":"",
            "type":"object"
        },
        "resourceName":{
            "description":"",
            "type":"string"
        },
        "serviceName":{
            "description":"",
            "type":"string"
        },
        "limit":{
            "description":"",
            "type":"number"
        },
        "createdBy":{
            "description":"",
            "type":"string"
        },
        "modifiedBy":{
            "description":"",
            "type":"string"
        },
        "action":{
            "description":"",
            "type":"string"
        },
        "alertLevel":{
            "description":"",
            "type":"number"
        },
        "limitType":{
            "description":"",
            "type":"string"
        },
        "valueType":{
            "description":"",
            "type":"string"
        },
        "status":{
            "description":"",
            "type":"string"
        },
        "maxHardLimit":{
            "description":"",
            "type":"string"
        },
        "skuPartId":{
            "description":"",
            "type":"string"
        }
    },
    "description":""
}

Nested Schema : createdOn

Type: object

Nested Schema : modifiedOn

Type: object

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