Uploaded image for project: 'CloudStack'
  1. CloudStack
  2. CLOUDSTACK-4912

API docs are missing some APIs

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Critical
    • Resolution: Fixed
    • 4.2.0, 4.3.0
    • 4.4.0
    • API, Doc
    • Security Level: Public (Anyone can view this level - this is the default.)
    • None

    Description

      I grep’ed the source code and came up with a list of the APIs which the UI uses. Many of them (addNetscalerLoadBalancer, addVmwareDc, etc.) are not in the generated API documentation which appears at http://cloudstack.apache.org/docs/api/apidocs-4.2/TOC_Root_Admin.html

      Here’s the list of APIs used by the UI:

      activateProject

      addAccountToProject

      addBaremetalDhcp

      addBaremetalPxeKickStartServer

      addCluster

      addHost

      addImageStore

      addIpToNic

      addLdapConfiguration

      addNetscalerLoadBalancer

      addNetworkServiceProvider

      addNicToVirtualMachine

      addRegion

      addTrafficType

      addUcsManager

      addVmwareDc

      addVpnUser

      archiveAlerts

      archiveEvents

      assignToGlobalLoadBalancerRule

      assignToLoadBalancerRule

      assignVirtualMachine

      associateIpAddress

      associateUcsProfileToBlade

      attachIso

      attachVolume

      authorizeSecurityGroupEgress

      authorizeSecurityGroupIngress

      cancelHostMaintenance

      cancelStorageMaintenance

      configureInternalLoadBalancerElement

      configureVirtualRouterElement

      copyIso

      copyTemplate

      createAccount

      createAffinityGroup

      createAutoScalePolicy

      createAutoScaleVmGroup

      createAutoScaleVmProfile

      createCondition

      createDiskOffering

      createDomain

      createEgressFirewallRule

      createFirewallRule

      createGlobalLoadBalancerRule

      createIpForwardingRule

      createLBHealthCheckPolicy

      createLBStickinessPolicy

      createLoadBalancer

      createLoadBalancerRule

      createNetwork

      createNetworkACL

      createNetworkACLList

      createNetworkOffering

      createPhysicalNetwork

      createPod

      createPortableIpRange

      createPortForwardingRule

      createPrivateGateway

      createProject

      createRemoteAccessVpn

      createSecondaryStagingStore

      createSecurityGroup

      createServiceOffering

      createSnapshot

      createSnapshotPolicy

      createStaticRoute

      createStorageNetworkIpRange

      createStoragePool

      createTags

      createTemplate

      createUser

      createVlanIpRange

      createVMSnapshot

      createVolume

      createVPC

      createVpnConnection

      createVpnCustomerGateway

      createVpnGateway

      createZone

      dedicateCluster

      dedicateGuestVlanRange

      dedicateHost

      dedicatePod

      dedicatePublicIpRange

      dedicateZone

      deleteAccount

      deleteAccountFromProject

      deleteAffinityGroup

      deleteAlerts

      deleteBigSwitchVnsDevice

      deleteCiscoNexusVSM

      deleteCluster

      deleteCondition

      deleteDiskOffering

      deleteDomain

      deleteEgressFirewallRule

      deleteEvents

      deleteF5LoadBalancer

      deleteFirewallRule

      deleteGlobalLoadBalancerRule

      deleteHost

      deleteImageStore

      deleteIpForwardingRule

      deleteIso

      deleteLBHealthCheckPolicy

      deleteLBStickinessPolicy

      deleteLdapConfiguration

      deleteLoadBalancer

      deleteLoadBalancerRule

      deleteNetscalerLoadBalancer

      deleteNetwork

      deleteNetworkACL

      deleteNetworkACLList

      deleteNetworkOffering

      deleteNetworkServiceProvider

      deleteNiciraNvpDevice

      deletePhysicalNetwork

      deletePod

      deletePortableIpRange

      deletePortForwardingRule

      deletePrivateGateway

      deleteProject

      deleteProjectInvitation

      deleteRemoteAccessVpn

      deleteSecondaryStagingStore

      deleteSecurityGroup

      deleteServiceOffering

      deleteSnapshot

      deleteSnapshotPolicies

      deleteSrxFirewall

      deleteStaticRoute

      deleteStorageNetworkIpRange

      deleteStoragePool

      deleteTags

      deleteTemplate

      deleteUcsManager

      deleteUser

      deleteVlanIpRange

      deleteVMSnapshot

      deleteVolume

      deleteVPC

      deleteVpnConnection

      deleteVpnCustomerGateway

      deleteVpnGateway

      deleteZone

      deployVirtualMachine

      destroyRouter

      destroySystemVm

      destroyVirtualMachine

      detachIso

      detachVolume

      disableAccount

      disableAutoScaleVmGroup

      disableCiscoNexusVSM

      disableStaticNat

      disableUser

      disassociateIpAddress

      disassociateUcsProfileFromBlade

      enableAccount

      enableAutoScaleVmGroup

      enableCiscoNexusVSM

      enableStaticNat

      enableStorageMaintenance

      enableUser

      extractVolume

      findHostsForMigration

      findStoragePoolsForMigration

      ldapCreateAccount

      listAccounts

      listAffinityGroups

      listAffinityGroupTypes

      listAlerts

      listAutoScaleVmGroups

      listAutoScaleVmProfiles

      listBaremetalDhcp

      listBaremetalPxeServers

      listBigSwitchVnsDevices

      listCapabilities

      listCapacity

      listCiscoNexusVSMs

      listClusters

      listConfigurations

      listCounters

      listDedicatedClusters

      listDedicatedGuestVlanRanges

      listDedicatedHosts

      listDedicatedPods

      listDedicatedZones

      listDeploymentPlanners

      listDiskOfferings

      listDomainChildren

      listDomains

      listEgressFirewallRules

      listEvents

      listF5LoadBalancers

      listFirewallRules

      listGlobalLoadBalancerRules

      listHosts

      listHypervisorCapabilities

      listHypervisors

      listImageStores

      listInternalLoadBalancerElements

      listInternalLoadBalancerVMs

      listIpForwardingRules

      listIsos

      listLBHealthCheckPolicies

      listLBStickinessPolicies

      listLdapConfigurations

      listLdapUsers

      listLoadBalancerRuleInstances

      listLoadBalancerRules

      listLoadBalancers

      listNetscalerLoadBalancers

      listNetworkACLLists

      listNetworkACLs

      listNetworkOfferings

      listNetworks

      listNetworkServiceProviders

      listNiciraNvpDevices

      listNics

      listOsCategories

      listOsTypes

      listPhysicalNetworks

      listPods

      listPortableIpRanges

      listPortForwardingRules

      listPrivateGateways

      listProjectAccounts

      listProjectInvitations

      listProjects

      listPublicIpAddresses

      listRegions

      listRemoteAccessVpns

      listResourceLimits

      listRouters

      listSecondaryStagingStores

      listSecurityGroups

      listServiceOfferings

      listSnapshotPolicies

      listSnapshots

      listSrxFirewalls

      listStaticRoutes

      listStorageNetworkIpRange

      listStoragePools

      listStorageProviders

      listSupportedNetworkServices

      listSystemVms

      listTags

      listTemplates

      listTrafficTypes

      listUcsBlades

      listUcsManagers

      listUcsProfiles

      listUsers

      listVirtualMachines

      listVirtualRouterElements

      listVlanIpRanges

      listVMSnapshot

      listVmwareDcs

      listVolumes

      listVPCOfferings

      listVPCs

      listVpnConnections

      listVpnCustomerGateways

      listVpnGateways

      listVpnUsers

      listZones

      logout

      migrateSystemVm

      migrateVirtualMachine

      migrateVirtualMachineWithVolume

      migrateVolume

      prepareHostForMaintenance

      rebootRouter

      rebootSystemVm

      rebootVirtualMachine

      reconnectHost

      recoverVirtualMachine

      registerIso

      registerTemplate

      registerUserKeys

      releaseDedicatedCluster

      releaseDedicatedGuestVlanRange

      releaseDedicatedHost

      releaseDedicatedPod

      releaseDedicatedZone

      releasePublicIpRange

      removeFromGlobalLoadBalancerRule

      removeFromLoadBalancerRule

      removeIpFromNic

      removeNicFromVirtualMachine

      removeRegion

      removeVmwareDc

      removeVpnUser

      replaceNetworkACLList

      resetPasswordForVirtualMachine

      resetVpnConnection

      resizeVolume

      restartNetwork

      restartVPC

      restoreVirtualMachine

      revertToVMSnapshot

      revokeSecurityGroupEgress

      revokeSecurityGroupIngress

      scaleSystemVm

      scaleVirtualMachine

      startInternalLoadBalancerVM

      startRouter

      startSystemVm

      startVirtualMachine

      stopInternalLoadBalancerVM

      stopRouter

      stopSystemVm

      stopVirtualMachine

      suspendProject

      updateAccount

      updateAutoScalePolicy

      updateAutoScaleVmGroup

      updateAutoScaleVmProfile

      updateCluster

      updateConfiguration

      updateDefaultNicForVirtualMachine

      updateDiskOffering

      updateDomain

      updateHost

      updateHypervisorCapabilities

      updateIso

      updateIsoPermissions

      updateLoadBalancerRule

      updateNetwork

      updateNetworkACLItem

      updateNetworkOffering

      updateNetworkServiceProvider

      updatePhysicalNetwork

      updatePod

      updateProject

      updateProjectInvitation

      updateRegion

      updateResourceCount

      updateResourceLimit

      updateServiceOffering

      updateStoragePool

      updateTemplate

      updateTemplatePermissions

      updateTrafficType

      updateUser

      updateVirtualMachine

      updateVMAffinityGroup

      updateVPC

      updateVpnCustomerGateway

      updateZone

      uploadCustomCertificate

      uploadVolume

      Attachments

        Activity

          People

            ke4qqq David Nalley
            dtsitrelis Demetrius Tsitrelis
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: