Configure Aging Policy for a Resource

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameConfigure Aging Policy for a Resource
Description

Attaches, Detaches, or Replaces the aging policy for a CloudCenter resource

Allowed Role(s)WM_USER
MethodPOST
URI

v2/agingPolicies/policyId

cloudcenter-ccm-backend/api/v2/agingPolicies/policyId

Sample Request
curl -k -X POST -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v2/agingPolicies/21"
curl -k -X POST -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v2/agingPolicies/21"
Release

Introduced in CloudCenter 4.8.2

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: create.agingPolicies.policyId

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample Request

{
    "resourceId": "1",
    "resourceType":"JOB",
    "operation":"ATTACH",
    "newPolicyId": null
}

Response

The server responds with the HTTP Response code 200 OK if the policy action on the resource is successful.

Request Attributes

resourceId
  • Description: Unique identifier for a CloudCenter Resource managed by ACLs. This ID is generated automatically by the CloudCenter platform when the resource is created.  
  • Type: String

resourceType
  • Description: The data type for a CloudCenter Resource.

  • Type: Enumeration

    StringCategory
    JOBIdentifies the resource to be a job or deployment

operation
  • Description: The deployment details for a resource that is attached to an aging policy can be changed as identified in the table below. 

  • Type: Enumeration

    EnumerationDescription
    ATTACHAdd an aging policy if one is not associated for this resource.
    DETACHRemove a policy that is currently attached to this resource.
    REPLACE

    Replaces the current aging policy with another one that you specify using a newPolicyId. If a policy specifies a time or cost that is less that what has accrued for the deployment, then the policy is not available for this resource.

newPolicyId
  • Description: A system-generated policyId that you must manually specify to identify the policy that you want to REPLACE in place of the currently configured policy operation.

  • Type: String

Response Attributes

None


© 2017-2019 Cisco Systems, Inc. All rights reserved