> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# admin_show_cluster_operations

<div className="kinetica-pydoc">
  <div className="dl py method">
    <div className="dt sig sig-object py" id="gpudb.GPUdb.admin_show_cluster_operations"> <span className="sig-name descname"><span className="pre">admin\_show\_cluster\_operations</span></span><span className="sig-paren">(</span><span className="em sig-param"><span className="n"><span className="pre">history\_index</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">0</span></span></span>, <span className="em sig-param"><span className="n"><span className="pre">options</span></span><span className="o"><span className="pre">=</span></span><span className="default_value"><span className="pre">{"{"}{"}"}</span></span></span><span className="sig-paren">)</span><a href="https://github.com/kineticadb/kinetica-api-python/blob/master/gpudb/gpudb.py#L15263"><span className="viewcode-link"><span className="pre">\[source]</span></span></a></div>

    <div className="dd">
      <p>Requests the detailed status of the current operation (by default) or a prior cluster operation specified by input parameter <span className="em">history\_index</span>. Returns details on the requested cluster operation.</p>
      <p>The response will also indicate how many cluster operations are stored in the history.</p>
      <p><strong>Parameters</strong></p>

      <div className="blockquote">
        <div>
          <div className="dl simple">
            <div className="dt">history\_index (<span className="em">int</span>) –</div>

            <div className="dd">
              <p>Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0.</p>
            </div>

            <div className="dt">options (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Optional parameters. The default value is an empty dict ( {"{"}{"}"} ).</p>
            </div>
          </div>
        </div>
      </div>

      <p><strong>Returns</strong></p>

      <div className="blockquote">
        <div>
          <p>A dict with the following entries–</p>

          <div className="dl simple">
            <div className="dt">history\_index (<span className="em">int</span>) –</div>

            <div className="dd">
              <p>The index of this cluster operation in the reverse-chronologically sorted list of operations, where 0 is the most recent operation.</p>
            </div>

            <div className="dt">history\_size (<span className="em">int</span>) –</div>

            <div className="dd">
              <p>Number of cluster operations executed to date.</p>
            </div>

            <div className="dt">in\_progress (<span className="em">bool</span>) –</div>

            <div className="dd">
              <p>Whether this cluster operation is currently in progress or not. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>True</p>
                </li>

                <li>
                  <p>False</p>
                </li>
              </ul>
            </div>

            <div className="dt">start\_time (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>The start time of the cluster operation.</p>
            </div>

            <div className="dt">end\_time (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>The end time of the cluster operation, if completed.</p>
            </div>

            <div className="dt">endpoint (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>The endpoint that initiated the cluster operation.</p>
            </div>

            <div className="dt">endpoint\_schema (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>The schema for the original request.</p>
            </div>

            <div className="dt">overall\_status (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>Overall success status of the operation. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p><strong>OK</strong> – The operation was successful, or, if still in progress, the operation is successful so far.</p>
                </li>

                <li>
                  <p><strong>ERROR</strong> – An error occurred executing the operation.</p>
                </li>
              </ul>
            </div>

            <div className="dt">user\_stopped (<span className="em">bool</span>) –</div>

            <div className="dd">
              <p>Whether a user stopped this operation at any point while in progress. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>True</p>
                </li>

                <li>
                  <p>False</p>
                </li>
              </ul>
            </div>

            <div className="dt">percent\_complete (<span className="em">int</span>) –</div>

            <div className="dd">
              <p>Percent complete of this entire operation.</p>
            </div>

            <div className="dt">dry\_run (<span className="em">bool</span>) –</div>

            <div className="dd">
              <p>Whether this operation was a dry run. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>True</p>
                </li>

                <li>
                  <p>False</p>
                </li>
              </ul>
            </div>

            <div className="dt">messages (<span className="em">list of str</span>) –</div>

            <div className="dd">
              <p>Updates and error messages if any.</p>
            </div>

            <div className="dt">add\_ranks (<span className="em">bool</span>) –</div>

            <div className="dd">
              <p>Whether adding ranks is (or was) part of this operation. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>True</p>
                </li>

                <li>
                  <p>False</p>
                </li>
              </ul>
            </div>

            <div className="dt">add\_ranks\_status (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>If this was a rank-adding operation, the add-specific status of the operation. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>NOT\_STARTED</p>
                </li>

                <li>
                  <p>IN\_PROGRESS</p>
                </li>

                <li>
                  <p>INTERRUPTED</p>
                </li>

                <li>
                  <p>COMPLETED\_OK</p>
                </li>

                <li>
                  <p>ERROR</p>
                </li>
              </ul>
            </div>

            <div className="dt">ranks\_being\_added (<span className="em">list of ints</span>) –</div>

            <div className="dd">
              <p>The rank numbers of the ranks currently being added, or the rank numbers that were added if the operation is complete.</p>
            </div>

            <div className="dt">rank\_hosts (<span className="em">list of str</span>) –</div>

            <div className="dd">
              <p>The host IP addresses of the ranks being added, in the same order as the output parameter <span className="em">ranks\_being\_added</span> list.</p>
            </div>

            <div className="dt">add\_ranks\_percent\_complete (<span className="em">int</span>) –</div>

            <div className="dd">
              <p>Current percent complete of the add ranks operation.</p>
            </div>

            <div className="dt">remove\_ranks (<span className="em">bool</span>) –</div>

            <div className="dd">
              <p>Whether removing ranks is (or was) part of this operation. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>True</p>
                </li>

                <li>
                  <p>False</p>
                </li>
              </ul>
            </div>

            <div className="dt">remove\_ranks\_status (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>If this was a rank-removing operation, the removal-specific status of the operation. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>NOT\_STARTED</p>
                </li>

                <li>
                  <p>IN\_PROGRESS</p>
                </li>

                <li>
                  <p>INTERRUPTED</p>
                </li>

                <li>
                  <p>COMPLETED\_OK</p>
                </li>

                <li>
                  <p>ERROR</p>
                </li>
              </ul>
            </div>

            <div className="dt">ranks\_being\_removed (<span className="em">list of ints</span>) –</div>

            <div className="dd">
              <p>The ranks being removed, or that have been removed if the operation is completed.</p>
            </div>

            <div className="dt">remove\_ranks\_percent\_complete (<span className="em">int</span>) –</div>

            <div className="dd">
              <p>Current percent complete of the remove ranks operation.</p>
            </div>

            <div className="dt">rebalance (<span className="em">bool</span>) –</div>

            <div className="dd">
              <p>Whether data and/or shard rebalancing is (or was) part of this operation. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>True</p>
                </li>

                <li>
                  <p>False</p>
                </li>
              </ul>
            </div>

            <div className="dt">rebalance\_unsharded\_data (<span className="em">bool</span>) –</div>

            <div className="dd">
              <p>Whether rebalancing of unsharded data is (or was) part of this operation. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>True</p>
                </li>

                <li>
                  <p>False</p>
                </li>
              </ul>
            </div>

            <div className="dt">rebalance\_unsharded\_data\_status (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of the operation. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>NOT\_STARTED</p>
                </li>

                <li>
                  <p>IN\_PROGRESS</p>
                </li>

                <li>
                  <p>INTERRUPTED</p>
                </li>

                <li>
                  <p>COMPLETED\_OK</p>
                </li>

                <li>
                  <p>ERROR</p>
                </li>
              </ul>
            </div>

            <div className="dt">unsharded\_rebalance\_percent\_complete (<span className="em">int</span>) –</div>

            <div className="dd">
              <p>Percentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance.</p>
            </div>

            <div className="dt">rebalance\_sharded\_data (<span className="em">bool</span>) –</div>

            <div className="dd">
              <p>Whether rebalancing of sharded data is (or was) part of this operation. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>True</p>
                </li>

                <li>
                  <p>False</p>
                </li>
              </ul>
            </div>

            <div className="dt">shard\_array\_version (<span className="em">long</span>) –</div>

            <div className="dd">
              <p>Version of the shard array that is (or was) being rebalanced to. Each change to the shard array results in the version number incrementing.</p>
            </div>

            <div className="dt">rebalance\_sharded\_data\_status (<span className="em">str</span>) –</div>

            <div className="dd">
              <p>If this was an operation that included rebalancing sharded data, the rebalancing-specific status of the operation. Allowed values are:</p>

              <ul className="simple">
                <li>
                  <p>NOT\_STARTED</p>
                </li>

                <li>
                  <p>IN\_PROGRESS</p>
                </li>

                <li>
                  <p>INTERRUPTED</p>
                </li>

                <li>
                  <p>COMPLETED\_OK</p>
                </li>

                <li>
                  <p>ERROR</p>
                </li>
              </ul>
            </div>

            <div className="dt">num\_shards\_changing (<span className="em">int</span>) –</div>

            <div className="dd">
              <p>Number of shards that will change as part of rebalance.</p>
            </div>

            <div className="dt">sharded\_rebalance\_percent\_complete (<span className="em">int</span>) –</div>

            <div className="dd">
              <p>Percentage of shard keys, and their associated data if applicable, that have completed rebalancing.</p>
            </div>

            <div className="dt">info (<span className="em">dict of str to str</span>) –</div>

            <div className="dd">
              <p>Additional information.</p>
            </div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>