"Fossies" - the Fresh Open Source Software Archive

Member "keystone-17.0.0/api-ref/source/v3/service-catalog.inc" (13 May 2020, 9373 Bytes) of package /linux/misc/openstack/keystone-17.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 "service-catalog.inc" see the Fossies "Dox" file reference documentation and the latest Fossies "Diffs" side-by-side code changes report: 16.0.1_vs_17.0.0.

    1 .. -*- rst -*-
    2 
    3 ===============================
    4  Service catalog and endpoints
    5 ===============================
    6 
    7 A service is an OpenStack web service that you can access through a
    8 URL, i.e. an endpoint.
    9 
   10 A service catalog lists the services that are available to the
   11 caller based upon the current authorization.
   12 
   13 You can create, list, show details for, update, and delete
   14 services. When you create or update a service, you can enable the
   15 service, which causes it and its endpoints to appear in the service
   16 catalog.
   17 
   18 You can create, list, show details for, update, and delete endpoints.
   19 
   20 
   21 List services
   22 =============
   23 
   24 .. rest_method::  GET /v3/services
   25 
   26 Lists all services.
   27 
   28 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/services``
   29 
   30 Request
   31 -------
   32 
   33 Parameters
   34 ~~~~~~~~~~
   35 
   36 .. rest_parameters:: parameters.yaml
   37 
   38    - type: service_type_query
   39 
   40 Response
   41 --------
   42 
   43 Parameters
   44 ~~~~~~~~~~
   45 
   46 .. rest_parameters:: parameters.yaml
   47 
   48    - name: service_name
   49    - links: service_links
   50    - enabled: service_enabled
   51    - services: services
   52    - type: service_type
   53    - id: service_id
   54    - description: service_description
   55 
   56 Status Codes
   57 ~~~~~~~~~~~~
   58 
   59 .. rest_status_code:: success status.yaml
   60 
   61    - 200
   62 
   63 .. rest_status_code:: error status.yaml
   64 
   65    - 400
   66    - 401
   67    - 403
   68 
   69 Example
   70 ~~~~~~~
   71 
   72 .. literalinclude:: ./samples/admin/services-list-response.json
   73    :language: javascript
   74 
   75 
   76 Create service
   77 ==============
   78 
   79 .. rest_method::  POST /v3/services
   80 
   81 Creates a service.
   82 
   83 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/services``
   84 
   85 Request
   86 -------
   87 
   88 Parameters
   89 ~~~~~~~~~~
   90 
   91 .. rest_parameters:: parameters.yaml
   92 
   93    - description: service_description
   94    - service: service
   95    - enabled: service_enabled
   96    - type: service_type
   97    - name: service_name
   98 
   99 Example
  100 ~~~~~~~
  101 
  102 .. literalinclude:: ./samples/admin/service-create-request.json
  103    :language: javascript
  104 
  105 Response
  106 --------
  107 
  108 Parameters
  109 ~~~~~~~~~~
  110 
  111 .. rest_parameters:: parameters.yaml
  112 
  113    - name: service_name
  114    - service: service
  115    - links: service_links
  116    - type: service_type
  117    - id: service_id
  118    - description: service_description
  119 
  120 Status Codes
  121 ~~~~~~~~~~~~
  122 
  123 .. rest_status_code:: success status.yaml
  124 
  125    - 201
  126 
  127 .. rest_status_code:: error status.yaml
  128 
  129    - 400
  130    - 401
  131    - 403
  132    - 409
  133 
  134 Show service details
  135 ====================
  136 
  137 .. rest_method::  GET /v3/services/{service_id}
  138 
  139 Shows details for a service.
  140 
  141 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/service``
  142 
  143 Request
  144 -------
  145 
  146 Parameters
  147 ~~~~~~~~~~
  148 
  149 .. rest_parameters:: parameters.yaml
  150 
  151    - service_id: service_id_path
  152 
  153 Response
  154 --------
  155 
  156 Parameters
  157 ~~~~~~~~~~
  158 
  159 .. rest_parameters:: parameters.yaml
  160 
  161    - name: service_name
  162    - service: service
  163    - links: service_links
  164    - type: service_type
  165    - id: service_id
  166    - description: service_description
  167 
  168 Status Codes
  169 ~~~~~~~~~~~~
  170 
  171 .. rest_status_code:: success status.yaml
  172 
  173    - 200
  174 
  175 .. rest_status_code:: error status.yaml
  176 
  177    - 400
  178    - 401
  179    - 403
  180    - 404
  181 
  182 Example
  183 ~~~~~~~
  184 
  185 .. literalinclude:: ./samples/admin/service-show-response.json
  186    :language: javascript
  187 
  188 
  189 Update service
  190 ==============
  191 
  192 .. rest_method::  PATCH /v3/services/{service_id}
  193 
  194 Updates a service.
  195 
  196 The request body is the same as the create service request body,
  197 except that you include only those attributes that you want to
  198 update.
  199 
  200 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/services``
  201 
  202 Request
  203 -------
  204 
  205 Parameters
  206 ~~~~~~~~~~
  207 
  208 .. rest_parameters:: parameters.yaml
  209 
  210    - type: service_type
  211    - enabled: service_enabled_not_required
  212    - description: service_description_not_required
  213    - service: service
  214    - name: service_name
  215    - service_id: service_id_path
  216 
  217 Example
  218 ~~~~~~~
  219 
  220 .. literalinclude:: ./samples/admin/service-update-request.json
  221    :language: javascript
  222 
  223 Response
  224 --------
  225 
  226 Parameters
  227 ~~~~~~~~~~
  228 
  229 .. rest_parameters:: parameters.yaml
  230 
  231    - name: service_name
  232    - service: service
  233    - links: service_links
  234    - type: service_type
  235    - id: service_id
  236    - description: service_description
  237 
  238 Status Codes
  239 ~~~~~~~~~~~~
  240 
  241 .. rest_status_code:: success status.yaml
  242 
  243    - 200
  244 
  245 .. rest_status_code:: error status.yaml
  246 
  247    - 400
  248    - 401
  249    - 403
  250    - 404
  251    - 409
  252 
  253 Example
  254 ~~~~~~~
  255 
  256 .. literalinclude:: ./samples/admin/service-update-response.json
  257    :language: javascript
  258 
  259 
  260 Delete service
  261 ==============
  262 
  263 .. rest_method::  DELETE /v3/services/{service_id}
  264 
  265 Deletes a service.
  266 
  267 If you try to delete a service that still has associated endpoints,
  268 this call either deletes all associated endpoints or fails until
  269 all endpoints are deleted.
  270 
  271 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/service``
  272 
  273 Request
  274 -------
  275 
  276 Parameters
  277 ~~~~~~~~~~
  278 
  279 .. rest_parameters:: parameters.yaml
  280 
  281    - service_id: service_id_path
  282 
  283 Response
  284 --------
  285 
  286 Status Codes
  287 ~~~~~~~~~~~~
  288 
  289 .. rest_status_code:: success status.yaml
  290 
  291    - 204
  292 
  293 .. rest_status_code:: error status.yaml
  294 
  295    - 400
  296    - 401
  297    - 403
  298    - 404
  299 
  300 
  301 List endpoints
  302 ==============
  303 
  304 .. rest_method::  GET /v3/endpoints
  305 
  306 Lists all available endpoints.
  307 
  308 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoints``
  309 
  310 Request
  311 -------
  312 
  313 Parameters
  314 ~~~~~~~~~~
  315 
  316 .. rest_parameters:: parameters.yaml
  317 
  318    - interface: interface_query
  319    - service_id: service_id_query
  320 
  321 Response
  322 --------
  323 
  324 Parameters
  325 ~~~~~~~~~~
  326 
  327 .. rest_parameters:: parameters.yaml
  328 
  329    - region_id: region_id_required
  330    - links: endpoints_links
  331    - url: endpoint_url
  332    - region: endpoint_region
  333    - enabled: endpoint_enabled
  334    - interface: endpoint_interface
  335    - service_id: service_id
  336    - endpoints: endpoints
  337    - id: endpoint_id
  338 
  339 Status Codes
  340 ~~~~~~~~~~~~
  341 
  342 .. rest_status_code:: success status.yaml
  343 
  344    - 200
  345 
  346 .. rest_status_code:: error status.yaml
  347 
  348    - 400
  349    - 401
  350    - 403
  351 
  352 Example
  353 ~~~~~~~
  354 
  355 .. literalinclude:: ./samples/admin/endpoints-list-response.json
  356    :language: javascript
  357 
  358 
  359 Create endpoint
  360 ===============
  361 
  362 .. rest_method::  POST /v3/endpoints
  363 
  364 Creates an endpoint.
  365 
  366 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoints``
  367 
  368 Request
  369 -------
  370 
  371 Parameters
  372 ~~~~~~~~~~
  373 
  374 .. rest_parameters:: parameters.yaml
  375 
  376    - endpoint: endpoint
  377    - url: endpoint_url
  378    - enabled: endpoint_enabled_not_required
  379    - interface: endpoint_interface
  380    - service_id: service_id
  381    - region_id: region_id_not_required
  382 
  383 Example
  384 ~~~~~~~
  385 
  386 .. literalinclude:: ./samples/admin/endpoint-create-request.json
  387    :language: javascript
  388 
  389 Response
  390 --------
  391 
  392 Parameters
  393 ~~~~~~~~~~
  394 
  395 .. rest_parameters:: parameters.yaml
  396 
  397    - endpoint: endpoint
  398    - links: endpoint_links
  399    - url: endpoint_url
  400    - region: endpoint_region
  401    - enabled: endpoint_enabled
  402    - interface: endpoint_interface
  403    - service_id: service_id
  404    - id: endpoint_id
  405    - region_id: region_id_required
  406 
  407 Status Codes
  408 ~~~~~~~~~~~~
  409 
  410 .. rest_status_code:: success status.yaml
  411 
  412    - 201
  413 
  414 .. rest_status_code:: error status.yaml
  415 
  416    - 400
  417    - 401
  418    - 403
  419    - 409
  420 
  421 
  422 Show endpoint details
  423 =====================
  424 
  425 .. rest_method::  GET /v3/endpoints/{endpoint_id}
  426 
  427 Shows details for an endpoint.
  428 
  429 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoints``
  430 
  431 Request
  432 -------
  433 
  434 Parameters
  435 ~~~~~~~~~~
  436 
  437 .. rest_parameters:: parameters.yaml
  438 
  439    - endpoint_id: endpoint_id_path
  440 
  441 Response
  442 --------
  443 
  444 Parameters
  445 ~~~~~~~~~~~
  446 
  447 .. rest_parameters:: parameters.yaml
  448 
  449    - endpoint: endpoint
  450    - name: endpoint_name
  451    - links: endpoint_links
  452    - url: endpoint_url
  453    - region: endpoint_region
  454    - interface: endpoint_interface
  455    - service_id: service_id
  456 
  457 Status Codes
  458 ~~~~~~~~~~~~
  459 
  460 .. rest_status_code:: success status.yaml
  461 
  462    - 200
  463 
  464 .. rest_status_code:: error status.yaml
  465 
  466    - 400
  467    - 401
  468    - 403
  469    - 404
  470 
  471 Example
  472 ~~~~~~~
  473 
  474 .. literalinclude:: ./samples/admin/endpoint-show-response.json
  475    :language: javascript
  476 
  477 
  478 Update endpoint
  479 ===============
  480 
  481 .. rest_method::  PATCH /v3/endpoints/{endpoint_id}
  482 
  483 Updates an endpoint.
  484 
  485 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoint``
  486 
  487 Request
  488 -------
  489 
  490 Parameters
  491 ~~~~~~~~~~
  492 
  493 .. rest_parameters:: parameters.yaml
  494 
  495    - endpoint: endpoint
  496    - url: endpoint_url
  497    - region: endpoint_region
  498    - interface: endpoint_interface
  499    - service_id: service_id
  500    - endpoint_id: endpoint_id_path
  501 
  502 Example
  503 ~~~~~~~
  504 
  505 .. literalinclude:: ./samples/admin/endpoint-update-request.json
  506    :language: javascript
  507 
  508 Response
  509 --------
  510 
  511 Parameters
  512 ~~~~~~~~~~
  513 
  514 .. rest_parameters:: parameters.yaml
  515 
  516    - endpoint: endpoint
  517    - id: endpoint_id
  518    - links: endpoint_links
  519    - url: endpoint_url
  520    - region: endpoint_region
  521    - interface: endpoint_interface
  522    - service_id: service_id
  523 
  524 Status Codes
  525 ~~~~~~~~~~~~
  526 
  527 .. rest_status_code:: success status.yaml
  528 
  529    - 200
  530 
  531 .. rest_status_code:: error status.yaml
  532 
  533    - 400
  534    - 401
  535    - 403
  536    - 404
  537    - 409
  538 
  539 Example
  540 ~~~~~~~
  541 
  542 .. literalinclude:: ./samples/admin/endpoint-update-response.json
  543    :language: javascript
  544 
  545 
  546 Delete endpoint
  547 ===============
  548 
  549 .. rest_method::  DELETE /v3/endpoints/{endpoint_id}
  550 
  551 Deletes an endpoint.
  552 
  553 Relationship: ``https://docs.openstack.org/api/openstack-identity/3/rel/endpoint``
  554 
  555 Request
  556 -------
  557 
  558 Parameters
  559 ~~~~~~~~~~
  560 
  561 .. rest_parameters:: parameters.yaml
  562 
  563    - endpoint_id: endpoint_id_path
  564 
  565 Response
  566 --------
  567 
  568 Status Codes
  569 ~~~~~~~~~~~~
  570 
  571 .. rest_status_code:: success status.yaml
  572 
  573    - 204
  574 
  575 .. rest_status_code:: error status.yaml
  576 
  577    - 400
  578    - 401
  579    - 403
  580    - 404