CliQr is now part of Cisco Learn More About Cisco

View Cloud Accounts

Details

API Details
Name

View Cloud Accounts

DescriptionDisplays information for each cloud account or for a specified cloud account within the specified tenant.
MethodGET
URI
  • v1/tenants/tenantId/clouds/cloudId/accounts
  • v1/tenants/tenantId/clouds/cloudId/accounts/cloudAccountId 
  • v1/tenants/tenantId/clouds/cloudId/accounts?accountName=me@mycompany.com  
  • v1/tenants/tenantId/clouds/cloudId/accounts?displayName=My Display Name                  
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.
  • If you include a cloudAccountId, accountName, or displayName, the response includes information for the cloud account with that ID, name, or display name only.
  • You can include both an accountName and displayName, in which case the response includes information for the cloud account with that name and display name only.
  • Only cloud account owners and users with WRITE perms (at a minimum) can view all the fields for a cloud account. Other users can only view common fields like account name, display name, description, and so forth. See Permission Control for additional context.
ESB Header
  • action: get.tenants.tenantId.clouds.cloudId.accounts
  • action: get.tenants.tenantId.clouds.cloudId.accounts.cloudAccountId 
  • action: get.tenants.tenantId.clouds.cloudId.accounts
    actionparam: accountName=me@mycompany.com  
  • action: get.tenants.tenantId.clouds.cloudId/accounts
    actionparam: displayName=My Display Name  

Example

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds/1/accounts"

Response

  • v1/tenants/tenantId/clouds/cloudId/accounts


  • v1/tenants/tenantId/clouds/cloudId/accounts/cloudAccountId

  • v1/tenants/tenantId/clouds/cloudId/accounts?accountName=admin@company.com 


  • v1/tenants/tenantId/clouds/cloudId/accounts?displayName=CloudCenter

      

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 Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

cloudId
  • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

  • Type: String

cloudAccountId
  • Description: Unique, system-generated identifier for the cloudAccount
  • Type: String
accountName
  • Description:The account name associated with this cloud account
  • Type: String 
displayName
  • DescriptionA descriptive name for this CloudCenter resource.
  • Type: String

 

Response Attributes

resource
  • Description: Unique URL to access this resource
  • Type: String
See pageResource or Pagination for additional context
perms (click for addtional details)
cloudAccounts
  • Description: Identifies information about each cloud account
  • Type: Array of cloud accounts

    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)

    displayName
    • DescriptionA descriptive name for this CloudCenter resource.
    • Type: String

    Required

    cloudId
    • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

    • Type: String

    Required

    userId
    • Description: Unique, system-generated identifier for a user
    • Type: String

    Required

    accountName
    • Description:The account name associated with this cloud account
    • Type: String 

    Required

    accountId
    • Description: Unique, system-generated identifier for the account of the cloud provider
    • Type: String

    Required

    accountPassword
    • Description:Password for the account of the cloud provider
    • Type: String

    Required

    accountDescription
    • Description:A brief description of this cloud account
    • Type: String

    Required

    manageCost
    • Description: Indicates whether the CloudCenter platform tracks your cloud account costs for billing purposes. See Configure Cloud(s) for additional context.

      • true = The CloudCenter platform tracks your cloud account costs
      • false = Default. The CloudCenter platform does not track your cloud account costs
    • Type: Boolean
    publicVisible
    • Description: Indicates whether this cloud publicly accessible. See Supported Public Clouds for additional context.

      • true = cloud is publicly accessible
      • false = cloud is not publicly accessible
    • Type: Boolean 
    allowedUsers
    • Description: Indicates the IDs of the users who are authorized to access this cloud account
    • Type: Integer (array)
     accessPermission 
    • Description: Identifies who can access this cloud account. Once set you cannot change this attribute.

    • Type: Enumeration

      EnumerationDescription
      PRIVATEDefault. The cloud account is accessible only by the owner of the cloud account.
      USERSThe cloud account is accessible by all tenant users of the cloud account.
      USERS_AND_SUBTENANT_USERSThe cloud account is accessible by all tenant and sub-tenant users of the cloud account.

    accountProperties
    • Description: Property information for this cloud account
    • Type: Name-Value Pair (array)