Update CCO Configuration

Details

API Details
NameUpdate CCO Configuration
Description

Use this API for both the initial CCO registration as well as subsequent updates for a cloud group. See CCO and Register the CCO with the CCM for additional context.

MethodPUT
URIv1/tenants/tenantId/clouds/cloudId/regions/regionId/gateway
CloudCenter ReleaseIntroduced in CloudCenter 4.0.
Notes

For additional context on <PORT> usage in the following example, see Base URI Format.

ESB Headeraction: update.tenants.tenantId.clouds.cloudId.regions.regionId.gateway

Example

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

Request Body

{
    "address": "10.1.1.15",
    "dnsName": "",
    "cloudAccountId": "1",
    "cloudId": 1
}

Response

{
    "address": "10.1.1.15",
    "dnsName": null,
    "status": "RUNNING",
    "cloudId": "1",
    "cloudAccountId": "1"
}

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
regionId
  • DescriptionUnique, system-generated identifier for the cloud region 
  • Type: String
address
  • Description: The DNS name or the IP address of the resource VM (for example, CCO, storage)
  • Type: String
dnsName
  • DescriptionThe DNS name or IP address of the Remote Desktop Gateway
  • Type: String
cloudAccountId
  • Description: Unique, system-generated identifier for the cloudAccount
  • Type: String
cloudId
  • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

  • Type: String

Response Attributes

address
  • Description: The DNS name or the IP address of the resource VM (for example, CCO, storage)
  • Type: String
dnsName
  • DescriptionThe DNS name or IP address of the Remote Desktop Gateway
  • Type: String
status
  • Description: Status of this resource 
  • Type: Enumeration

    EnumerationDescription
    RUNNINGThe cloud account is operational
    STOPPEDThe cloud account is not operational
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