Governance Enforcement Recommendation APIs

This contains APIs related to CACM Governance Enforcement Recommendations

Accept governance rule enforcement recommendations for given enforcement recommendation ids.

put

Accept governance rule enforcement recommendations.

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

enforcementRecommendationIdsstring[]Optional

Enforcement Recommendation Ids

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

True/false if governance rule enforcement recommendations are successfully accepted.

application/json

put/governance/enforcementRecommendation/accept

PUT /gateway/ccm/api/governance/enforcementRecommendation/accept?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-ssnpc
Accept: */*

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

Dismiss governance rule enforcement recommendations for given enforcement recommendation ids.

put

Dismiss governance rule enforcement recommendations.

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

enforcementRecommendationIdsstring[]Optional

Enforcement Recommendation Ids

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

True/false if governance rule enforcement recommendations are successfully dismissed.

application/json

put/governance/enforcementRecommendation/dismiss

PUT /gateway/ccm/api/governance/enforcementRecommendation/dismiss?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-ssnpc
Accept: */*

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

Get governance rule enforcement recommendation details for given enforcement recommendation id.

get

Get governance rule enforcement recommendation details.

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

enforcementRecommendationIdstringOptional

Enforcement Recommendation Id

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 Enforcement details

application/json

get/governance/enforcementRecommendation/details

GET /gateway/ccm/api/governance/enforcementRecommendation/details?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-ssnpc
Accept: */*

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

Deprecated

List governance rule enforcement recommendations for given accountId.

get

List governance rule enforcement recommendations.

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

searchKeystringOptional

pageinteger · int32Optional

Page number

Example: 0

pageSizeinteger · int32Optional

Number of items per page

Example: 20

sortTypestring · enumOptionalPossible values:

sortOrderstring · 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 list of governance enforcement recommendations.

application/json

get/governance/enforcementRecommendation/list

GET /gateway/ccm/api/governance/enforcementRecommendation/list?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-ssnpc
Accept: */*

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

List governance rule enforcement recommendations for given accountId.

post

List governance rule enforcement recommendations.

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Body

This has the query to list the RuleEnforcementRecommendations

ruleIdsstring[]Optional

ruleIds

searchKeystringOptional

searchKey

targetAccountsstring[]Optional

targetAccounts

targetRegionsstring[]Optional

targetRegions

isDryRunbooleanOptional

isDryRun

isEnabledbooleanOptional

isEnabled

sortTypestring · enumOptional

ruleEnforcementSortType

Possible values:

sortOrderstring · enumOptional

sortOrder

Possible values:

pageNumberinteger · int32Optional

pageNumber

pageSizeinteger · int32Optional

pageSize

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 list of governance enforcement recommendations.

application/json

post/governance/enforcementRecommendation/list

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

{
  "ruleIds": [
    "text"
  ],
  "searchKey": "text",
  "targetAccounts": [
    "text"
  ],
  "targetRegions": [
    "text"
  ],
  "isDryRun": true,
  "isEnabled": true,
  "sortType": "NAME",
  "sortOrder": "ASCENDING",
  "pageNumber": 1,
  "pageSize": 1
}

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

Update a governance rule enforcement recommendation.

put

Update a governance rule enforcement recommendation.

Query parameters

accountIdentifierstringRequired

Account Identifier for the Entity.

Body

This object will contain the complete definition of a Cloud Cost Rule Enforcement generated by AI assistant

uuidstringOptional

unique id

accountIdstringOptional

account id

namestringOptional

name

descriptionstringOptional

Description of the entity

tagsstring[]Optional

Tags

orgIdentifierstringOptional

Organization Identifier for the Entity.

projectIdentifierstringOptional

Project Identifier for the Entity.

cloudProviderstring · enumOptional

cloudProvider

Possible values:

ruleIdsstring[]Optional

rulesIds

ruleSetIDsstring[]Optional

ruleSetIDs

executionSchedulestringOptional

executionSchedule

executionTimezonestringOptional

executionTimezone

targetAccountsstring[]Optional

targetAccounts

targetRegionsstring[]Optional

targetRegions

isDryRunbooleanOptional

isDryRun

runCountinteger · int32Optional

runCount

isEnabledbooleanOptional

isEnabled

ruleEnforcementRecommendationStatusstring · enumOptional

ruleEnforcementRecommendationStatus

Possible values:

pricingCostTypestringOptional

pricingCostType

createdAtinteger · int64Optional

Time at which the entity was created

lastUpdatedAtinteger · int64Optional

Time at which the entity was last updated

ruleEnforcementTypestring · 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

Updated governance rule enforcement recommendation.

application/json

put/governance/enforcementRecommendation/update

PUT /gateway/ccm/api/governance/enforcementRecommendation/update?accountIdentifier=text HTTP/1.1
Host: nextgen-ce-d788d786-ssnpc
Content-Type: application/json
Accept: */*
Content-Length: 649

{
  "uuid": "text",
  "accountId": "text",
  "name": "text",
  "description": "text",
  "tags": [
    "text"
  ],
  "orgIdentifier": "text",
  "projectIdentifier": "text",
  "cloudProvider": "AWS",
  "ruleIds": [
    "text"
  ],
  "ruleSetIDs": [
    "text"
  ],
  "executionSchedule": "text",
  "executionTimezone": "text",
  "targetAccounts": [
    "text"
  ],
  "targetRegions": [
    "text"
  ],
  "isDryRun": true,
  "runCount": 1,
  "isEnabled": true,
  "ruleEnforcementRecommendationStatus": "NEW",
  "pricingCostType": "text",
  "createdAt": 1,
  "lastUpdatedAt": 1,
  "createdBy": {
    "uuid": "text",
    "name": "text",
    "email": "text",
    "externalUserId": "text"
  },
  "lastUpdatedBy": {
    "uuid": "text",
    "name": "text",
    "email": "text",
    "externalUserId": "text"
  },
  "ruleEnforcementType": "INTERNAL"
}

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