CliQr is now part of Cisco Learn More About Cisco

Update Cloud Accounts

Details

API Details
Name

Update Cloud Accounts by Cloud Account ID.

Description
MethodPUT
URI

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

CloudCenter ReleaseIntroduced in CloudCenter 4.0.
NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Headeraction: update.tenants.tenantId.clouds.cloudId.accounts.cloudAccountId

Example

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

Details before the Change

Request Body

Request to change the accountDescription (from "CloudCenterQA Account" to "CloudCenter QA Account for the documentation group")

Response for this Request

Get API after the Change

 

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

Required

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

  • Type: String

Required

cloudAccountId
  • Description: Unique, system-generated identifier for the cloudAccount
  • Type: String

Required

accountDescription
  • Description:A brief description of this cloud account
  • Type: String
accountProperties
  • Description: Property information for this cloud account
  • Type: Name-Value Pair (array)

Response Attributes

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)