Jump to

• Request
• Response

Get a Service Resource Limit Definitions

get

/20190729/limitDefinitions

List resource limit definitions that are supported by the given service. If a subscription ID is provided, then only resource limits supported by subscription are returned. If the areQuotasSupported property is true, you can create quota policies at the compartment level to further limit resources.

Request

Supported Media Types

• application/json

Query Parameters

• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 100

  The OCID of the parent compartment (remember that the tenancy is simply the root compartment).
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. Example: 50

  Default Value: 100
• name: string
  Optional field, filter for a specific resource limit.
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: 0
• serviceName: string
  The target service name.
• sortBy: string
  The field to sort by.

  Default Value: name

  Allowed Values: [ "name", "description" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Default Value: ASC

  Allowed Values: [ "ASC", "DESC" ]
• subscriptionId: string
  The OCID of the subscription assigned to tenant

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list of definitions has been successfully loaded, sorted alphabetically by the description field.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object LimitDefinitionSummary
  The metadata specific to a resource limit definition.

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

Nested Schema : LimitDefinitionSummary

Type: object

The metadata specific to a resource limit definition.

Show Source

• areQuotasSupported: boolean
  If true, quota policies can be created on top of this resource limit.
• description: string
  The limit description.
• isDeprecated: boolean
  Indicates if the limit has been deprecated.
• isDynamic: boolean
  The limit for this resource has a dynamic value that is based on consumption across all OCI services.
• isEligibleForLimitIncrease: boolean
  Indicates if the customer can request a limit increase for this resource.
• isResourceAvailabilitySupported: boolean
  Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.
• name: string
  The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.
• scopeType: string
  Allowed Values: [ "GLOBAL", "REGION", "AD" ]

  Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.
• serviceName: string
  The service name of the limit.
• supportedQuotaFamilies: array supportedQuotaFamilies
  Supported quota family names for creation of quota policy.
• supportedSubscriptions: array supportedSubscriptions
  An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'.

{
    "x-obmcs-splat":{
        "resourceKind":"resource-availability",
        "adLocality":"regional",
        "activeLifecycleStates":[
            ""
        ],
        "deletedLifecycleStates":[
            ""
        ],
        "listResourcesOperationId":"ListLimitDefinitions"
    },
    "type":"object",
    "description":"The metadata specific to a resource limit definition.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls. "
        },
        "serviceName":{
            "type":"string",
            "description":"The service name of the limit."
        },
        "description":{
            "type":"string",
            "description":"The limit description."
        },
        "scopeType":{
            "type":"string",
            "enum":[
                "GLOBAL",
                "REGION",
                "AD"
            ],
            "description":"Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific. "
        },
        "areQuotasSupported":{
            "type":"boolean",
            "description":"If true, quota policies can be created on top of this resource limit. "
        },
        "isResourceAvailabilitySupported":{
            "type":"boolean",
            "description":"Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response. "
        },
        "isDeprecated":{
            "type":"boolean",
            "description":"Indicates if the limit has been deprecated. "
        },
        "isEligibleForLimitIncrease":{
            "type":"boolean",
            "description":"Indicates if the customer can request a limit increase for this resource. "
        },
        "isDynamic":{
            "type":"boolean",
            "description":"The limit for this resource has a dynamic value that is based on consumption across all OCI services. "
        },
        "supportedSubscriptions":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'. "
        },
        "supportedQuotaFamilies":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Supported quota family names for creation of quota policy. "
        }
    }
}

Nested Schema : supportedQuotaFamilies

Type: array

Supported quota family names for creation of quota policy.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Supported quota family names for creation of quota policy. "
}

Nested Schema : supportedSubscriptions

Type: array

An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"An array of subscription types supported by the limit. e,g The type of subscription, such as 'SAAS', 'ERP', 'CRM'. "
}

400 Response

A bad request was made or the request is not supported for the current tenant.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

User authentication has failed.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not authorized or not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

You have issued too many requests to the Oracle Cloud Infrastructure APIs in too short of an amount of time.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal server error.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top