"Fossies" - the Fresh Open Source Software Archive

Member "senlin-8.0.0/api-ref/source/cluster_policies.inc" (16 Oct 2019, 2248 Bytes) of package /linux/misc/openstack/senlin-8.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 "cluster_policies.inc" see the Fossies "Dox" file reference documentation.

    1 ===================================
    2 Cluster Policies (cluster-policies)
    3 ===================================
    4 
    5 Lists all cluster policies and shows information for a cluster policy.
    6 
    7 List all cluster policies
    8 =========================
    9 
   10 .. rest_method::  GET /v1/clusters/{cluster_id}/policies
   11 
   12 Lists all policies attached to specific cluster
   13 
   14 Response Codes
   15 --------------
   16 
   17 .. rest_status_code:: success status.yaml
   18 
   19    - 200
   20 
   21 .. rest_status_code:: error status.yaml
   22 
   23    - 400
   24    - 401
   25    - 403
   26    - 404
   27    - 503
   28 
   29 Request Parameters
   30 ------------------
   31 
   32 .. rest_parameters:: parameters.yaml
   33 
   34   - OpenStack-API-Version: microversion
   35   - cluster_id: cluster_id_url
   36   - enabled: enabled_query
   37   - policy_name: name_query
   38   - policy_type: type_query
   39   - sort: sort
   40 
   41 Response Parameters
   42 -------------------
   43 
   44 .. rest_parameters:: parameters.yaml
   45 
   46   - X-OpenStack-Request-ID: request_id
   47   - cluster_policies: cluster_policies
   48   - cluster_id: cluster_id
   49   - cluster_name: cluster_name
   50   - enabled: cluster_policy_enabled
   51   - id: cluster_policy_id
   52   - policy_id: policy_id
   53   - policy_name: policy_name
   54   - policy_type: policy_type_name
   55 
   56 Response Example
   57 ----------------
   58 
   59 .. literalinclude:: samples/cluster-policies-list-response.json
   60    :language: javascript
   61 
   62 
   63 Show cluster_policy details
   64 ===========================
   65 
   66 .. rest_method::  GET /v1/clusters/{cluster_id}/policies/{policy_id}
   67 
   68 Shows details for a cluster policy.
   69 
   70 Response Codes
   71 --------------
   72 
   73 .. rest_status_code:: success status.yaml
   74 
   75    - 200
   76 
   77 .. rest_status_code:: error status.yaml
   78 
   79    - 400
   80    - 401
   81    - 403
   82    - 404
   83    - 503
   84 
   85 Request Parameters
   86 ------------------
   87 
   88 .. rest_parameters:: parameters.yaml
   89 
   90   - OpenStack-API-Version: microversion
   91   - cluster_id: cluster_id_url
   92   - policy_id: policy_id_url
   93 
   94 Response Parameters
   95 -------------------
   96 
   97 .. rest_parameters:: parameters.yaml
   98 
   99   - X-OpenStack-Request-ID: request_id
  100   - cluster_policy: cluster_policy
  101   - cluster_id: cluster_id
  102   - cluster_name: cluster_name
  103   - enabled: cluster_policy_enabled
  104   - id: cluster_policy_id
  105   - policy_id: policy_id
  106   - policy_name: policy_name
  107   - policy_type: policy_type_name
  108 
  109 Response Example
  110 ----------------
  111 
  112 .. literalinclude:: samples/cluster-policy-show-response.json
  113    :language: javascript