CliQr is now part of Cisco Learn More About Cisco

View CCO Configuration

Details

API Details
Name

View CCO Configuration

Description

Use this API to view the CCO registration details. See CCO and Register the CCO with the CCM for additional context.

MethodGET
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.
  • 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.
ESB Headeraction: get.tenants.tenantId.clouds.cloudId.regions.regionId.gateway

Example

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

Response

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

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