Jump to

• Request
• Response
• Examples

Update Hard or Soft Limits for Resources

put

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

Define or modify hard or soft limits for resources of a given service entitlement.

Request

Supported Media Types

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

Path Parameters

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

Body ()

Limit definition.

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

Back to Top

Response

Supported Media Types

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

201 Response

Success

Body ()

Root Schema : schema

Type: file

Default Response

Unexpected error.

Back to Top

Examples

cURL Command

The following example shows how to update hard/soft limits for resources by submitting a PUT 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 PUT 
     -u [e-mail] 
     -H "X-ID-TENANT-NAME:myDomain" 
     -H "Accept: application/vnd.com.oracle.oraclecloud.metering.cloudbucklimits+json" 
     -H "Content-Type: application/vnd.com.oracle.oraclecloud.metering.cloudbucklimits+json" 
     "https://itra.oraclecloud.com/metering/api/v1/cloudbucklimits/sseyz05242hng/504299053"

Example of Request Body

The following shows an example of the request body content in the requestbody.json file.

{
	"items": [
		{
		"resourceName": "OCPU",
		"serviceName": "Compute",
		"id":"896430081",
		"limit": 20,
		"createdBy": "[e-mail]",
		"modifiedBy": "[e-mail]",
		"action": "ALERT",
		"limitType": "SOFT",
		"valueType": "ABSOLUTE"
		}
	]
}

Example of Response Body

There is no response body for this HTTP request.

Back to Top