"Fossies" - the Fresh Open Source Software Archive

Member "keystone-18.0.0/api-ref/source/v3/unified_limits.inc" (14 Oct 2020, 12128 Bytes) of package /linux/misc/openstack/keystone-18.0.0.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) fasm source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. For more information about "unified_limits.inc" see the Fossies "Dox" file reference documentation and the latest Fossies "Diffs" side-by-side code changes report: 17.0.0_vs_18.0.0.

    1 .. -*- rst -*-
    2 
    3 ==============
    4 Unified Limits
    5 ==============
    6 
    7 In OpenStack, a quota system mainly contains two parts: ``limit`` and
    8 ``usage``. The Unified limits in Keystone is a replacement of the ``limit``
    9 part. It contains two kinds of resouces: ``Registered Limit`` and ``Limit``. A
   10 ``registered limit`` is a default limit. It is usually created by the services
   11 which are registered in Keystone. A ``limit`` is the limit that override the
   12 registered limit for each project.
   13 
   14 List Registered Limits
   15 ======================
   16 
   17 .. rest_method::  GET /v3/registered_limits
   18 
   19 Lists Registered Limits.
   20 
   21 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limits``
   22 
   23 Request
   24 -------
   25 
   26 Parameters
   27 ~~~~~~~~~~
   28 
   29 .. rest_parameters:: parameters.yaml
   30 
   31    - service_id: service_id_query
   32    - region_id: region_id_query
   33    - resource_name: resource_name_query
   34 
   35 
   36 Response
   37 --------
   38 
   39 Parameters
   40 ~~~~~~~~~~
   41 
   42 .. rest_parameters:: parameters.yaml
   43 
   44    - links: link_collection
   45    - registered_limits: registered_limits
   46    - id: registered_limit_id
   47    - service_id: service_id_registered_limit
   48    - region_id: region_id_response_body
   49    - resource_name: resource_name
   50    - default_limit: default_limit
   51    - description: description_registered_limit_response_body
   52    - links: link_response_body
   53 
   54 
   55 Status Codes
   56 ~~~~~~~~~~~~
   57 
   58 .. rest_status_code:: success status.yaml
   59 
   60    - 200
   61 
   62 .. rest_status_code:: error status.yaml
   63 
   64    - 401
   65    - 403
   66 
   67 Example
   68 ~~~~~~~
   69 
   70 .. literalinclude:: ./samples/admin/registered-limits-list-response.json
   71    :language: javascript
   72 
   73 
   74 Create Registered Limits
   75 ========================
   76 
   77 .. rest_method::  POST /v3/registered_limits
   78 
   79 Creates registered limits. It supports to create more than one registered limit
   80 in one request.
   81 
   82 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limits``
   83 
   84 Request
   85 -------
   86 
   87 Parameters
   88 ~~~~~~~~~~
   89 
   90 .. rest_parameters:: parameters.yaml
   91 
   92    - registered_limits: registered_limits
   93    - service_id: service_id_registered_limit
   94    - region_id: region_id_request_body
   95    - resource_name: resource_name
   96    - default_limit: default_limit
   97    - description: description_registered_limit_request_body
   98 
   99 Examples
  100 ~~~~~~~~
  101 
  102 
  103 .. literalinclude:: ./samples/admin/registered-limits-create-request.json
  104    :language: javascript
  105 
  106 
  107 Response
  108 --------
  109 
  110 Parameters
  111 ~~~~~~~~~~
  112 
  113 .. rest_parameters:: parameters.yaml
  114 
  115    - registered_limits: registered_limits
  116    - id: registered_limit_id
  117    - service_id: service_id_registered_limit
  118    - region_id: region_id_response_body
  119    - resource_name: resource_name
  120    - default_limit: default_limit
  121    - description: description_registered_limit_response_body
  122    - links: link_response_body
  123 
  124 Status Codes
  125 ~~~~~~~~~~~~
  126 
  127 .. rest_status_code:: success status.yaml
  128 
  129    - 201
  130 
  131 .. rest_status_code:: error status.yaml
  132 
  133    - 400
  134    - 401
  135    - 403
  136    - 409
  137 
  138 Examples
  139 ~~~~~~~~
  140 
  141 
  142 .. literalinclude:: ./samples/admin/registered-limits-create-response.json
  143    :language: javascript
  144 
  145 
  146 Update Registered Limit
  147 ========================
  148 
  149 .. rest_method::  PATCH /v3/registered_limits/{registered_limit_id}
  150 
  151 Updates the specified registered limit.
  152 
  153 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limit``
  154 
  155 Request
  156 -------
  157 
  158 Parameters
  159 ~~~~~~~~~~
  160 
  161 .. rest_parameters:: parameters.yaml
  162 
  163    - registered_limit_id: registered_limit_id_path
  164    - registered_limit: registered_limit
  165    - service_id: request_service_id_registered_limit_body_not_required
  166    - region_id: request_region_id_registered_limit_body_not_required
  167    - resource_name: request_resource_name_body_not_required
  168    - default_limit: request_default_limit_body_not_required
  169    - description: description_registered_limit_request_body
  170 
  171 Example
  172 ~~~~~~~
  173 
  174 .. literalinclude:: ./samples/admin/registered-limits-update-request.json
  175    :language: javascript
  176 
  177 Response
  178 --------
  179 
  180 Parameters
  181 ~~~~~~~~~~
  182 
  183 .. rest_parameters:: parameters.yaml
  184 
  185    - registered_limit: registered_limit
  186    - id: registered_limit_id
  187    - service_id: service_id_registered_limit
  188    - region_id: region_id_response_body
  189    - resource_name: resource_name
  190    - default_limit: default_limit
  191    - description: description_registered_limit_response_body
  192    - links: link_response_body
  193 
  194 
  195 Status Codes
  196 ~~~~~~~~~~~~
  197 
  198 .. rest_status_code:: success status.yaml
  199 
  200    - 200
  201 
  202 .. rest_status_code:: error status.yaml
  203 
  204    - 400
  205    - 401
  206    - 403
  207    - 404
  208    - 409
  209 
  210 Example
  211 ~~~~~~~
  212 
  213 .. literalinclude:: ./samples/admin/registered-limits-update-response.json
  214    :language: javascript
  215 
  216 
  217 Show Registered Limit Details
  218 =============================
  219 
  220 .. rest_method::  GET /v3/registered_limits/{registered_limit_id}
  221 
  222 Shows details for a registered limit.
  223 
  224 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limit``
  225 
  226 Request
  227 -------
  228 
  229 Parameters
  230 ~~~~~~~~~~
  231 
  232 .. rest_parameters:: parameters.yaml
  233 
  234    - registered_limit_id: registered_limit_id_path
  235 
  236 Response
  237 --------
  238 
  239 Parameters
  240 ~~~~~~~~~~
  241 
  242 .. rest_parameters:: parameters.yaml
  243 
  244    - registered_limit: registered_limit
  245    - id: registered_limit_id
  246    - service_id: service_id_registered_limit
  247    - region_id: region_id_response_body
  248    - resource_name: resource_name
  249    - default_limit: default_limit
  250    - description: description_registered_limit_response_body
  251    - links: link_response_body
  252 
  253 Status Codes
  254 ~~~~~~~~~~~~
  255 
  256 .. rest_status_code:: success status.yaml
  257 
  258    - 200
  259 
  260 .. rest_status_code:: error status.yaml
  261 
  262    - 401
  263    - 403
  264    - 404
  265 
  266 Example
  267 ~~~~~~~
  268 
  269 .. literalinclude:: ./samples/admin/registered-limit-show-response.json
  270    :language: javascript
  271 
  272 
  273 Delete Registered Limit
  274 =======================
  275 
  276 .. rest_method::  DELETE /v3/registered_limits/{registered_limit_id}
  277 
  278 Deletes a registered limit.
  279 
  280 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/registered_limit``
  281 
  282 Request
  283 -------
  284 
  285 Parameters
  286 ~~~~~~~~~~
  287 
  288 .. rest_parameters:: parameters.yaml
  289 
  290    - registered_limit_id: registered_limit_id_path
  291 
  292 Response
  293 --------
  294 
  295 Status Codes
  296 ~~~~~~~~~~~~
  297 
  298 .. rest_status_code:: success status.yaml
  299 
  300    - 204
  301 
  302 .. rest_status_code:: error status.yaml
  303 
  304    - 401
  305    - 403
  306    - 404
  307 
  308 
  309 Get Enforcement Model
  310 =====================
  311 
  312 .. rest_method::  GET /v3/limits/model
  313 
  314 Return the configured limit enforcement model.
  315 
  316 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limit_model``
  317 
  318 Response
  319 --------
  320 
  321 Parameters
  322 ~~~~~~~~~~
  323 
  324 .. rest_parameters:: parameters.yaml
  325 
  326    - model: limit_model_required_response_body
  327    - name: limit_model_name_required_response_body
  328    - description: limit_model_description_required_response_body
  329 
  330 Status Codes
  331 ~~~~~~~~~~~~
  332 
  333 .. rest_status_code:: success status.yaml
  334 
  335    - 200
  336 
  337 .. rest_status_code:: error status.yaml
  338 
  339    - 401
  340    - 403
  341 
  342 Flat Enforcement Example
  343 ~~~~~~~~~~~~~~~~~~~~~~~~
  344 
  345 .. literalinclude:: ./samples/admin/limit-flat-model-response.json
  346    :language: javascript
  347 
  348 
  349 List Limits
  350 ===========
  351 
  352 .. rest_method::  GET /v3/limits
  353 
  354 Lists Limits.
  355 
  356 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limits``
  357 
  358 Request
  359 -------
  360 
  361 Parameters
  362 ~~~~~~~~~~
  363 
  364 .. rest_parameters:: parameters.yaml
  365 
  366    - service_id: service_id_query
  367    - region_id: region_id_query
  368    - resource_name: resource_name_query
  369    - project_id: scope_project_id_query
  370    - domain_id: scope_domain_id_query
  371 
  372 
  373 Response
  374 --------
  375 
  376 Parameters
  377 ~~~~~~~~~~
  378 
  379 .. rest_parameters:: parameters.yaml
  380 
  381    - links: link_collection
  382    - limits: limits
  383    - id: limit_id
  384    - project_id: project_id
  385    - domain_id: response_limit_domain_id_body
  386    - service_id: service_id_limit
  387    - region_id: region_id_response_body
  388    - resource_name: resource_name
  389    - resource_limit: resource_limit
  390    - description: description_limit_response_body
  391    - links: link_response_body
  392 
  393 
  394 Status Codes
  395 ~~~~~~~~~~~~
  396 
  397 .. rest_status_code:: success status.yaml
  398 
  399    - 200
  400 
  401 .. rest_status_code:: error status.yaml
  402 
  403    - 401
  404    - 403
  405 
  406 Example
  407 ~~~~~~~
  408 
  409 .. literalinclude:: ./samples/admin/limits-list-response.json
  410    :language: javascript
  411 
  412 
  413 Create Limits
  414 =============
  415 
  416 .. rest_method::  POST /v3/limits
  417 
  418 Creates limits. It supports to create more than one limit in one request.
  419 
  420 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limits``
  421 
  422 Request
  423 -------
  424 
  425 Parameters
  426 ~~~~~~~~~~
  427 
  428 .. rest_parameters:: parameters.yaml
  429 
  430    - limits: limits
  431    - project_id: request_limit_project_id_not_required
  432    - domain_id: request_limit_domain_id_not_required
  433    - service_id: service_id_limit
  434    - region_id: region_id_request_body
  435    - resource_name: resource_name
  436    - resource_limit: resource_limit
  437    - description: description_limit_request_body
  438 
  439 Examples
  440 ~~~~~~~~
  441 
  442 
  443 .. literalinclude:: ./samples/admin/limits-create-request.json
  444    :language: javascript
  445 
  446 
  447 Response
  448 --------
  449 
  450 Parameters
  451 ~~~~~~~~~~
  452 
  453 .. rest_parameters:: parameters.yaml
  454 
  455    - limits: limits
  456    - id: limit_id
  457    - project_id: project_id
  458    - domain_id: response_limit_domain_id_body
  459    - service_id: service_id_limit
  460    - region_id: region_id_response_body
  461    - resource_name: resource_name
  462    - resource_limit: resource_limit
  463    - description: description_limit_response_body
  464    - links: link_response_body
  465 
  466 Status Codes
  467 ~~~~~~~~~~~~
  468 
  469 .. rest_status_code:: success status.yaml
  470 
  471    - 201
  472 
  473 .. rest_status_code:: error status.yaml
  474 
  475    - 400
  476    - 401
  477    - 403
  478    - 409
  479 
  480 Examples
  481 ~~~~~~~~
  482 
  483 
  484 .. literalinclude:: ./samples/admin/limits-create-response.json
  485    :language: javascript
  486 
  487 
  488 Update Limit
  489 =============
  490 
  491 .. rest_method::  PATCH /v3/limits/{limit_id}
  492 
  493 Updates the specified limit. It only supports to update ``resource_limit`` or
  494 ``description`` for the limit.
  495 
  496 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limit``
  497 
  498 Request
  499 -------
  500 
  501 Parameters
  502 ~~~~~~~~~~
  503 
  504 .. rest_parameters:: parameters.yaml
  505 
  506    - limit_id: limit_id_path
  507    - limit: limit
  508    - resource_limit: request_resource_limit_body_not_required
  509    - description: description_limit_request_body
  510 
  511 Example
  512 ~~~~~~~
  513 
  514 .. literalinclude:: ./samples/admin/limits-update-request.json
  515    :language: javascript
  516 
  517 Response
  518 --------
  519 
  520 Parameters
  521 ~~~~~~~~~~
  522 
  523 .. rest_parameters:: parameters.yaml
  524 
  525    - limit: limit
  526    - id: limit_id
  527    - project_id: project_id
  528    - domain_id: response_limit_domain_id_body
  529    - service_id: service_id_limit
  530    - region_id: region_id_response_body
  531    - resource_name: resource_name
  532    - resource_limit: resource_limit
  533    - description: description_limit_response_body
  534    - links: link_response_body
  535 
  536 
  537 Status Codes
  538 ~~~~~~~~~~~~
  539 
  540 .. rest_status_code:: success status.yaml
  541 
  542    - 200
  543 
  544 .. rest_status_code:: error status.yaml
  545 
  546    - 400
  547    - 401
  548    - 403
  549    - 404
  550    - 409
  551 
  552 Example
  553 ~~~~~~~
  554 
  555 .. literalinclude:: ./samples/admin/limits-update-response.json
  556    :language: javascript
  557 
  558 
  559 Show Limit Details
  560 ==================
  561 
  562 .. rest_method::  GET /v3/limits/{limit_id}
  563 
  564 Shows details for a limit.
  565 
  566 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limit``
  567 
  568 Request
  569 -------
  570 
  571 Parameters
  572 ~~~~~~~~~~
  573 
  574 .. rest_parameters:: parameters.yaml
  575 
  576    - limit_id: limit_id_path
  577 
  578 Response
  579 --------
  580 
  581 Parameters
  582 ~~~~~~~~~~
  583 
  584 .. rest_parameters:: parameters.yaml
  585 
  586    - limit: limit
  587    - id: limit_id
  588    - project_id: project_id
  589    - domain_id: response_limit_domain_id_body
  590    - service_id: service_id_limit
  591    - region_id: region_id_response_body
  592    - resource_name: resource_name
  593    - resource_limit: resource_limit
  594    - description: description_limit_response_body
  595    - links: link_response_body
  596 
  597 Status Codes
  598 ~~~~~~~~~~~~
  599 
  600 .. rest_status_code:: success status.yaml
  601 
  602    - 200
  603 
  604 .. rest_status_code:: error status.yaml
  605 
  606    - 401
  607    - 403
  608    - 404
  609 
  610 Example
  611 ~~~~~~~
  612 
  613 .. literalinclude:: ./samples/admin/limit-show-response.json
  614    :language: javascript
  615 
  616 
  617 Delete Registered Limit
  618 =======================
  619 
  620 .. rest_method::  DELETE /v3/limits/{limit_id}
  621 
  622 Deletes a limit.
  623 
  624 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/limit``
  625 
  626 Request
  627 -------
  628 
  629 Parameters
  630 ~~~~~~~~~~
  631 
  632 .. rest_parameters:: parameters.yaml
  633 
  634    - limit_id: limit_id_path
  635 
  636 Response
  637 --------
  638 
  639 Status Codes
  640 ~~~~~~~~~~~~
  641 
  642 .. rest_status_code:: success status.yaml
  643 
  644    - 204
  645 
  646 .. rest_status_code:: error status.yaml
  647 
  648    - 401
  649    - 403
  650    - 404