List Space Quotas | Tanzu EAR Cloud Controller API

List Space Quotas

List space quotas

This endpoint lists all space quota resources that the user has permission to view.

Request

URI

GET

https://api.example.local/v3/space_quotas

COPY

Query Parameters

integer

page

Optional

Page to display; valid values are integers >= 1

page example

integer

per_page

Optional

Number of results per page, valid values are 1 through 5000

per_page example

string

order_by

Optional

Value to sort by. Defaults to ascending; prepend with - to sort descending.

order_by example

created_at

string of array

guids

Optional

Comma-delimited list of space quota guids to filter by

string of array

names

Optional

Comma-delimited list of space quota names to filter by

string of array

organization_guids

Optional

Comma-delimited list of organization guids to filter by

string of array

space_guids

Optional

Comma-delimited list of space guids to filter by

string

created_ats

Optional

Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with relational operators.

created_ats example

2021-01-01T00:00:00Z

string

updated_ats

Optional

Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. Also supports filtering with relational operators.

updated_ats example

2021-01-01T00:00:00Z

Authentication

This operation uses the following authentication methods.

oauth

bearer

Responses

200

Returns SpaceQuotaList of type(s) application/json

{
    "pagination": {
        "total_results": 0,
        "total_pages": 0,
        "first": {
            "href": "string",
            "method": "string"
        },
        "last": {
            "href": "string",
            "method": "string"
        },
        "next": {
            "href": "string",
            "method": "string"
        },
        "previous": {
            "href": "string",
            "method": "string"
        }
    },
    "resources": [
        {
            "guid": "string",
            "created_at": "string",
            "updated_at": "string",
            "name": "string",
            "apps": {
                "total_memory_in_mb": 0,
                "per_process_memory_in_mb": 0,
                "log_rate_limit_in_bytes_per_second": 0,
                "total_instances": 0,
                "per_app_tasks": 0
            },
            "services": {
                "paid_services_allowed": false,
                "total_service_instances": 0,
                "total_service_keys": 0
            },
            "routes": {
                "total_routes": 0,
                "total_reserved_ports": 0
            },
            "relationships": {
                "organization": {
                    "data": {
                        "guid": "string"
                    }
                },
                "spaces": {
                    "data": [
                        {
                            "guid": "string"
                        }
                    ]
                }
            },
            "links": {
                "self": {
                    "href": "string",
                    "method": "string"
                },
                "organization": {
                    "href": "string",
                    "method": "string"
                }
            },
            "metadata": {
                "labels": {
                    "labels": "string"
                },
                "annotations": {
                    "annotations": "string"
                }
            }
        }
    ]
}

object

pagination

Optional

Pagination is a technique used to divide a large set of results into smaller, more manageable sets. This allows clients to retrieve results in smaller chunks, reducing the amount of data transferred and improving performance. The pagination object is a JSON object that contains information about the pagination state of the results. It includes the total number of results available, the total number of pages available, and links to the first, last, next, and previous pages of results.

array of object

resources

Optional

resources

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

409

Conflict

Returns Conflict of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

422

Unprocessable Entity

Returns UnprocessableEntity of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

500

Internal Server Error

Returns 500 of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

502

Bad Gateway

Returns BadGateway of type(s) application/json

{
    "code": 0,
    "detail": "string",
    "title": "string"
}

integer

code

Optional

A numeric code for this error

string

detail

Optional

Detailed description of the error

string

title

Optional

Name of the error

503

Service Unavailable

Returns ServiceUnavailable of type(s) application/json

{
    "errors": [
        {
            "code": 0,
            "detail": "string",
            "title": "string"
        }
    ]
}

array of object

errors

Optional

errors

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/v3/space_quotas

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Space Quotas Operations

Remove Space Quota From Space