Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

ResourceQuota class

The ResourceQuota class represents a resource quota. A resource quota either establishes a limit on how much of a designated resource that a customer is permitted to consume or defines that there is no limit.

ResourceQuota class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the ResourceQuota class.

Basic APIs

Name

HTTP
method

URI

Description

create

POST

csm/ResourceQuota

Creates a ResourceQuota object.

delete

DELETE

csm/ResourceQuota/guid

Deletes a ResourceQuota object.

get

GET

csm/ResourceQuota/guid

Retrieves a ResourceQuota object.

update

POST

csm/ResourceQuota/guid/update

Updates a ResourceQuota object.

search

POST

csm/ResourceQuota/search

Searches for ResourceQuota objects.

Operation APIs

The ResourceQuota class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/ResourceQuota/guid/organization

Retrieves the organization relationship.

relation

GET

csm/ResourceQuota/guid/provider

Retrieves the provider relationship.

relation

GET

csm/ResourceQuota/guid/tags

Retrieves the tags relationship.

ResourceQuota class relationships and attributes

The following tables list the relationships and attributes of the ResourceQuota class.

Relationships

Name

Type

Multi-
plicity

Description

organization

Organization

1

Organization that is granted the resource quota

cloudClass

CloudClass

1

Fully-qualified name of the class to which the object belongs

provider

Provider

1

Provider that created the object

tags

Tag

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

Description

quotaAmount

Float

0..1

When unlimited is false, defines the amount of the resource that the organization is allowed to consume.

quotaUnit

String

0..1

Unit in which the quota is measured

resourceType

ResourceQuotaType

1

Type of resource for which the quota is established, such as number of CPUs or active service instances

unlimited

Boolean

0..1

Indicates whether the customer has an unlimited quota for this resource. When unlimited is true, the customer has no limit for this resource.

externalID

String

0..1

Identifier used for the object by an external provider

owner

String

0..1

Name of the owner of the object

reconciliationID

String

0..1

Reconciliation identity value for the object from the BMC Atrium CMDB

tokenID

String

0..1

Token identifier

description

String

0..1

Text that describes the object

guid

String

1

Globally unique identifier for the object

name

String

1

Human-readable name of the object

Was this page helpful? Yes No Submitting... Thank you

Comments