doc-exports/docs/ims/api-ref/en-us_topic_0000001411119581.html
Hasko, Vladimir 0c7b91f4bd Initial import of IMS API
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2022-10-05 08:51:25 +00:00

14 KiB

Querying the Image Quota

Function

This extension API is used to query the quota of private images of a tenant in the current region.

URI

GET /v1/cloudimages/quota

Request

  • Request parameters

    None

  • Example request
    GET https://{Endpoint}/v1/cloudimages/quota

Response

  • Response parameters

    Parameter

    Type

    Description

    quotas

    Object

    Specifies the quota information.

    For details, see Table 1.

    Table 1 Data structure description of the quotas field

    Parameter

    Type

    Description

    resources

    Array of objects

    Specifies the resources to be queried.

    For details, see Table 2.

    Table 2 Data structure description of the quotas.resources field

    Parameter

    Type

    Description

    type

    String

    Specifies the type of the resource to be queried.

    used

    Integer

    Specifies the used quota.

    quota

    Integer

    Specifies the total quota.

    min

    Integer

    Specifies the minimum quota.

    max

    Integer

    Specifies the maximum quota.

  • Example response
    STATUS CODE 200
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    {
      "quotas": {
        "resources": [
          {
            "type": "image",
            "used": 0,
            "quota": 20,
            "min": 1,
            "max": 1000
          }
        ]
      }
    }
    

Returned Value

  • Normal

    200

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    Request error. For details, see Error Codes.

    401 Unauthorized

    Authentication failed.

    403 Forbidden

    You do not have the rights to perform the operation.

    404 Not Found

    The requested resource was not found.

    500 Internal Server Error

    Internal service error.

    503 Service Unavailable

    The service is unavailable.