"Fossies" - the Fresh Open Source Software Archive

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