Rule Executions

This contains APIs related to Rule Executions

Export evaluations data

post

Export evaluations data

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Body

includeMetadataFilesbooleanOptional

includeResourceFilesbooleanOptional

includeLogFilesbooleanOptional

includeActionFilesbooleanOptional

includeRuleYamlbooleanOptional

includeInCsvFormatbooleanOptional

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Returns signed URL for download

application/json

post/governance/execution/export

POST /gateway/ccm/api/governance/execution/export?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Content-Type: application/json
Accept: */*
Content-Length: 786

{
  "ruleExecutionFilter": {
    "accountId": "text",
    "targetAccount": [
      "text"
    ],
    "executionStatus": "FAILED",
    "region": [
      "text"
    ],
    "cloudProvider": "AWS",
    "cloudProviders": [
      "AWS"
    ],
    "ruleIds": [
      "text"
    ],
    "ruleSetIds": [
      "text"
    ],
    "executionIds": [
      "text"
    ],
    "ruleEnforcementId": [
      "text"
    ],
    "ruleEnforcementRecommendationId": [
      "text"
    ],
    "time": [
      {
        "operator": "NOT_IN",
        "timestamp": 1
      }
    ],
    "limit": 1,
    "offset": 1,
    "savings": 1,
    "ruleExecutionSortType": "COST",
    "sortOrder": "ASCENDING",
    "resourceCountGreaterThanZero": true,
    "costType": "POTENTIAL",
    "isDryRun": true,
    "ccmTagDTOS": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "ccmCostCategoryCostBucketsDTOS": [
      {
        "costCategory": "text",
        "costBucket": [
          "text"
        ]
      }
    ]
  },
  "includeMetadataFiles": true,
  "includeResourceFiles": true,
  "includeLogFiles": true,
  "includeActionFiles": true,
  "includeRuleYaml": true,
  "includeInCsvFormat": true
}

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Fetch RuleExecutions for account

post

Fetch RuleExecutions

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Body

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Returns List of RuleExecution

application/json

post/governance/execution/list

POST /gateway/ccm/api/governance/execution/list?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Content-Type: application/json
Accept: */*
Content-Length: 634

{
  "policyExecutionFilter": {
    "accountId": "text",
    "targetAccount": [
      "text"
    ],
    "executionStatus": "FAILED",
    "region": [
      "text"
    ],
    "cloudProvider": "AWS",
    "cloudProviders": [
      "AWS"
    ],
    "ruleIds": [
      "text"
    ],
    "ruleSetIds": [
      "text"
    ],
    "executionIds": [
      "text"
    ],
    "ruleEnforcementId": [
      "text"
    ],
    "ruleEnforcementRecommendationId": [
      "text"
    ],
    "time": [
      {
        "operator": "NOT_IN",
        "timestamp": 1
      }
    ],
    "limit": 1,
    "offset": 1,
    "savings": 1,
    "ruleExecutionSortType": "COST",
    "sortOrder": "ASCENDING",
    "resourceCountGreaterThanZero": true,
    "costType": "POTENTIAL",
    "isDryRun": true,
    "ccmTagDTOS": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "ccmCostCategoryCostBucketsDTOS": [
      {
        "costCategory": "text",
        "costBucket": [
          "text"
        ]
      }
    ]
  }
}

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Rule Execution Filter Values

get

Rule Execution Filter Values

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Returns filter values for Rule Execution.

application/json

get/governance/execution/filter-value

GET /gateway/ccm/api/governance/execution/filter-value?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Get rule execution

get

Path parameters

ruleExecutionIdstringRequired

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

executionTypestring · enumOptionalPossible values:

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Return rule execution

application/json

get/governance/execution/{ruleExecutionId}

GET /gateway/ccm/api/governance/execution/{ruleExecutionId}?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Deprecated

Return actioned resources for a rule execution

get

Path parameters

ruleExecutionIdstringRequired

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Return actioned resources for a rule execution

application/json

get/governance/actionedResources/{ruleExecutionId}

GET /gateway/ccm/api/governance/actionedResources/{ruleExecutionId}?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Resources/logs for a rule execution

get

Path parameters

ruleExecutionIdstringRequired

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

fileTypestring · enumOptional

Select filetype, by default RESOURCE file will be selected

Possible values:

resourceIdstringOptional

subRuleNamestringOptional

executionTypestring · enumOptionalPossible values:

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Return resources/logs for a rule execution

application/json

get/governance/execution/details/{ruleExecutionId}

GET /gateway/ccm/api/governance/execution/details/{ruleExecutionId}?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Deprecated

Return resource for a rule execution

get

Path parameters

ruleExecutionIdstringRequired

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

resourceIdstringOptional

subRuleNamestringOptional

executionTypestring · enumOptionalPossible values:

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Return resource for a rule execution

application/json

get/governance/granularStatus/{ruleExecutionId}

GET /gateway/ccm/api/governance/granularStatus/{ruleExecutionId}?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Deprecated

Return logs for a rule execution

get

Path parameters

ruleExecutionIdstringRequired

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

executionTypestring · enumOptionalPossible values:

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Return logs for a rule execution

application/json

get/governance/logs/{ruleExecutionId}

GET /gateway/ccm/api/governance/logs/{ruleExecutionId}?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Deprecated

Return governance rule yaml for a rule execution

get

Path parameters

ruleExecutionIdstringRequired

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

executionTypestring · enumOptionalPossible values:

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Return governance rule yaml for a rule execution

application/json

get/governance/ruleYaml/{ruleExecutionId}

GET /gateway/ccm/api/governance/ruleYaml/{ruleExecutionId}?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Deprecated

Return resources for a rule execution

get

Path parameters

ruleExecutionIdstringRequired

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

executionTypestring · enumOptionalPossible values:

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Return resources for a rule execution

application/json

get/governance/status/{ruleExecutionId}

GET /gateway/ccm/api/governance/status/{ruleExecutionId}?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Find last execution given rules list

post

Find last execution given rules list

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Bodystring[]

string[]Optional

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Returns List of RuleExecutions.

application/json

post/governance/execution/ruleLastExecution

POST /gateway/ccm/api/governance/execution/ruleLastExecution?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

Refresh cost for a rule execution

get

Path parameters

ruleExecutionIdstringRequired

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

executionTypestring · enumOptionalPossible values:

Responses

202

Job enqueued to refresh cost for a rule execution

application/json

400

Bad Request

500

Internal server error

get/governance/execution/refreshCost/{ruleExecutionId}

GET /gateway/ccm/api/governance/execution/refreshCost/{ruleExecutionId}?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Accept: */*

Rule Execution Tag Filter Values

post

Rule Execution Tag Filter Values

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Body

This has the query to list the tags for RuleExecution

tagKeystringOptional

tagKey

searchstringOptional

limitinteger · int64Optional

limit

offsetinteger · int64Optional

offset

Responses

400

Bad Request

This is Failure entity as defied in Harness

statusstring · enumOptionalPossible values:

codestring · enumOptionalPossible values:

messagestringOptional

correlationIdstringOptional

500

Internal server error

default

Returns tag filter values for Rule Execution.

application/json

post/governance/execution/filter-value/tags

POST /gateway/ccm/api/governance/execution/filter-value/tags?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-jz7g5
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "tagKey": "text",
  "search": "text",
  "limit": 1,
  "offset": 1,
  "time": [
    {
      "operator": "NOT_IN",
      "timestamp": 1
    }
  ]
}

{
  "status": "SUCCESS",
  "code": "DEFAULT_ERROR_CODE",
  "message": "text",
  "correlationId": "text",
  "errors": [
    {
      "fieldId": "text",
      "error": "text"
    }
  ]
}

PreviousRule Enforcement

NextRule

Last updated 46 minutes ago

Was this helpful?