View Bundles

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView Bundle(s)
Description

Displays information for each bundle or for a specified bundle within the specified tenant

Allowed Role(s)WM_USER
MethodGET
URI
  • v1/tenants/tenantId/bundles
  • v1/tenants/tenantId/bundles/bundleId
  • cloudcenter-ccm-backend/api/v1/tenants/tenantId/bundles
  • cloudcenter-ccm-backend/api/v1/tenants/tenantId/bundles/bundleId
Sample Request
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/bundles"
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/tenants/1/bundles"
Release

Introduced in CloudCenter 4.0

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.
  • If you include a bundleId to identify a bundle, the response includes information for that bundle only.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get.tenants.tenantId.bundles
  • action: get.tenants.tenantId.bundles.bundleId

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

Not applicable

Sample Response

{
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/bundles",
    "size": 3,
    "pageNumber": 0,
    "totalElements": 3,
    "totalPages": 1,
    "bundles": [
        {
            "id": "1",
            "resource": https://<HOST>:<PORT>/v1/tenants/1/bundles/1,
            "perms": [],
            "name": "100 Hours",
            "description": "100 Hours Bundle",
            "tenantId": "1",
            "type": "TIME_BUNDLE",
            "limit": 100,
            "price": 100,
            "expirationDate": 0,
            "expirationMonths": 6,
            "publishedAppIds": [],
            "disabled": false,
            "showOnlyToAdmin": false,
            "numberOfUsers": 0
        },
        {
            "id": "2",
            "resource": https://<HOST>:<PORT>/v1/tenants/1/bundles/2,
            "perms": [],
            "name": "100 Dollars",
            "description": "$100 Bundle",
            "tenantId": "1",
            "type": "BUDGET_BUNDLE",
            "limit": 100,
            "price": 100,
            "expirationDate": 1451500200000,
            "expirationMonths": 0,
            "publishedAppIds": [],
            "disabled": false,
            "showOnlyToAdmin": false,
            "numberOfUsers": 0
        },
        {
            "id": "3",
            "resource": https://<HOST>:<PORT>/v1/tenants/1/bundles/3,
            "perms": [],
            "name": "Free 1000 Hours",
            "description": "Free 1000 Hours Bundle",
            "tenantId": "1",
            "type": "TIME_BUNDLE",
            "limit": 1000,
            "price": 0,
            "expirationDate": 0,
            "expirationMonths": 1,
            "publishedAppIds": [],
            "disabled": false,
            "showOnlyToAdmin": false,
            "numberOfUsers": 0
        }
    ]
}


Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.

  • Type: String
bundleId
  • Description: Unique, system-generated identifier for the bundle belonging to this tenant.
  • Type: String

Response Attributes

resource
  • Description: Unique URL to access this resource.
  • Type: String
See pageResource or Pagination for additional context
bundles
  • Description: Information about each bundle
  • Type: Array of bundles

    id
    • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

    • Type: String
    resource
    • Description: Unique URL to access this resource.
    • Type: String
    perms (click for additional details)

    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    Required

    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String

    tenantId
    • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.

    • Type: String

    Required

    bundleType
    • Description: Type type of bundle for this user or tenant. See the Financial Overview section and Permission Control section for the relevant release for additional content. 
    • Type: Enumeration

      EnumerationDescription
      TIME_BUNDLETime-based VM hours bundle example: Default. The 250 hours sign up offered through the CloudCenter Marketplace that includes the management fee at no additional cost. Typically, new users try out this bundle before their admin assigns them to a plan or before the user converts to a subscription plan.
      BUDGET_BUNDLEBudget-based $ limit bundle example: With a budget limit of $100, you can run applications until this amount is consumed. If your tenant admins set a management fee (for example, $0.10 per hour), then this amount is deducted from the $100 limit. Any additional cloud cost is also deducted from the $100 limit.

    Required

    limit
    • Description: The $-based limit for the bundleType. See the Financial Overview section for the relevant release for additional context.
    • Type: Integer

    price
    • DescriptionThe base price for this bundle or plan. Required in the request only for the monthlyLimit plans:
      • UNLIMITED_PLAN
      • VM_HOUR_SUBSCRIPTION_PLAN
      • VM_SUBSCRIPTION_PLAN
      • For the remaining prepaid plan type (TIME_BUNDLE_PREPAID_PLAN and BUDGET_BUNDLE_PREPAID_PLAN), the value defaults to 0
    • Type: Float

    Required

    expirationDate
    • DescriptionA period starting from the date of purchase or a fixed expiration date.
    • Type: Long

    Required

    expirationMonths
    • Description: Number of months that a plan is active
    • Type: Integer

    publishedAppIds
    • DescriptionUnique, system-generated identifier for applications published to the Marketplace
    • Type: Array of strings

    disabled
    • Description: Indicates whether this resource is disabled.
      • True = resource is disabled
      • false = resource is not disabled
    • Type: Boolean
    showOnlyToAdmin
    • Description: Indicates whether this resource is visible only to an administrator.
      • true = visibility of the resource is restricted to an administrator
      • false = visibility of the resource is not restricted to an administrator
    • Type: Boolean
    numberOfUsers
    • Description: Number of users that are currently using this resource
    • Type: Long

     



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