get-policy¶

Description¶

Fetches policy details like version IDs, policy actions, scope of the policy, status and associations.

Synopsis¶

  get-policy
--policy-name <value>
--datahub-crn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--policy-name (string)

The name of the policy.

--datahub-crn (string)

The CRN of the CLO Data Hub.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

versions -> (array)

List of all version IDs of the policy.

item -> (string)

policyDetail -> (object)

Policy detail corresponding to a unique policy version.

version -> (string)

The policy version which is a UUID.

arguments -> (blob)

JSON containing the action specific arguments and other user defined arguments.

scope -> (string)

The scope of the policy. It can be Catalog or Namespace.

associations -> (array)

The list containing table associations for each namespace.

item -> (object)

The table associations per namespace.

namespace -> (string)

The name of the namespace.

status -> (string)

The namespace status. Possible values are ERROR, SUCCESS, PAUSED, AUTO_PAUSED, USER_PAUSED, UNAVAILABLE and WARNING. PAUSED indicated that namespace is paused for maintenance actions, AUTO_PAUSED indicates namespace is paused automatically due to errors, USER_PAUSED indicates paused by user, ERROR indicates that recent task has failed or a table is in paused state due to exceptions, WARNING if a table is paused by user, SUCCESS if there are no recent task failures or paused tables, UNAVAILABLE if no tasks have run yet.

tableAssociations -> (array)

The list of associated tables and their details for a namespace.

item -> (object)

The object containing information about a table to policy association.

name -> (string)

The table name.

namespace -> (string)

The namespace name.

taskCount -> (integer)

The count of CLO tasks ran for the table.

lastExecutionTime -> (integer)

The time in epoch milliseconds of recent CLO task that ran for the table.

version -> (string)

The policy version applicable to this table.

status -> (string)

The table status.

tableCount -> (integer)

The count of associated tables.

creationTime -> (integer)

The policy creation time in epoch milliseconds.

lastExecutionTime -> (integer)

The recent policy execution epoch time in milliseconds.

Form Factors¶

public