# README
Go API client for cloudmgr
Cloud Manager Restful API Documentation.
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: v2.0
- Package version: 4.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit www.hashdata.cn
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import sw "./cloudmgr"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Configuration of Server URL
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
Select Server Configuration
For using other server than the one defined on index 0 set context value sw.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
.
An operation is uniquely identifield by "{classname}Service.{nickname}"
string.
Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices
and sw.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
Documentation for API Endpoints
All URIs are relative to http://localhost:8000
Class | Method | HTTP request | Description |
---|---|---|---|
AccountClientServiceApi | CreateClient | Post /account/api/v2/clients | Create a new client. |
AccountClientServiceApi | DeleteClient | Delete /account/api/v2/clients/{id} | Delete an existent client. |
AccountClientServiceApi | DescribeClient | Get /account/api/v2/clients/{id} | Describe the client detail with given client id. |
AccountClientServiceApi | ListClient | Get /account/api/v2/clients | List clients. |
AccountTeamServiceApi | AddUserToTeam | Post /account/api/v2/teams/{teamid}/users | Add an user to the team with given role. |
AccountTeamServiceApi | CreateTeam | Post /account/api/v2/teams | Create a new team. |
AccountTeamServiceApi | DeleteTeam | Delete /account/api/v2/teams/{teamid} | Delete an existent team. |
AccountTeamServiceApi | DeleteUserFromTeam | Delete /account/api/v2/teams/{teamid}/users/{userid} | Remove an user from a team. |
AccountTeamServiceApi | DescribeTeam | Get /account/api/v2/teams/{teamid} | Describe the detail of a team. |
AccountTeamServiceApi | ListTeam | Get /account/api/v2/teams | List all teams. |
AccountTeamServiceApi | ListUserOfTeam | Get /account/api/v2/teams/{teamid}/users | List all users of a team. |
AccountTeamServiceApi | ModifyTeam | Put /account/api/v2/teams/{teamid} | Modify an existent team. |
AccountTenantServiceApi | CreateExternalTenant | Post /account/api/v2/tenants/external | Create a new tenant from outside. |
AccountTenantServiceApi | CreateTenant | Post /account/api/v2/tenants | Create a new tenant. |
AccountTenantServiceApi | DeleteTenant | Delete /account/api/v2/tenants/{tenantid} | Delete a tenant. |
AccountTenantServiceApi | DescribeExternalTenant | Get /account/api/v2/tenants/external | Describe the detail of tenant. |
AccountTenantServiceApi | DescribeTenant | Get /account/api/v2/tenants/{tenantid} | Describe the detail of tenant. |
AccountTenantServiceApi | ListTenant | Get /account/api/v2/tenants | List all tenants. |
AccountUserServiceApi | ChangePassword | Put /account/api/v2/users/{userid}/password | Modify user's password. |
AccountUserServiceApi | ComplementExternalUserAndTenant | Put /account/api/v2/users/external/{user.id}/tenants/external/{tenant.id} | Complete external user's information and external tenant's information. |
AccountUserServiceApi | CreateExternalUser | Post /account/api/v2/users/external | Create a new user from outside. |
AccountUserServiceApi | CreateUser | Post /account/api/v2/users | Create a new user. |
AccountUserServiceApi | DeleteUser | Delete /account/api/v2/users/{userid} | Delete an user. |
AccountUserServiceApi | DescribeExternalUser | Get /account/api/v2/users/external | Describe the detail of an user. |
AccountUserServiceApi | DescribeSelf | Get /account/api/v2/users/self | Describe current login user. |
AccountUserServiceApi | DescribeUser | Get /account/api/v2/users/{userid} | Describe the detail of an user. |
AccountUserServiceApi | ListTeamOfUser | Get /account/api/v2/users/{userid}/teams | List all teams which the user belongs to. |
AccountUserServiceApi | ListUser | Get /account/api/v2/users | List all users. |
AccountUserServiceApi | ModifyUser | Put /account/api/v2/users/{userid} | Modify an user. |
AlertInfoServiceApi | ConfirmAlertInfo | Put /ops/api/v2/alertinfo/confirm/{id} | confirm a alert info. |
AlertInfoServiceApi | CreateAlertInfo | Post /ops/api/v2/alertinfo/create | create a alert info. |
AlertInfoServiceApi | DescribeAlertInfo | Get /ops/api/v2/alertinfo/{id} | get a alert info. |
AlertInfoServiceApi | ListAlertInfo | Get /ops/api/v2/alertinfos | list alert infos. |
AlertInfoServiceApi | ProcessAlertInfo | Put /ops/api/v2/alertinfo/process/{id} | processed a alert info. |
AlertmanagerServiceApi | CreateSilence | Post /ops/api/v2/silence | create silence of alertmanagement. |
AlertmanagerServiceApi | DeleteSilence | Delete /ops/api/v2/silence | delete silence of alertmanagement. |
AlertmanagerServiceApi | DescribeSilence | Get /ops/api/v2/silence/{id} | decribe silence of alertmanagement. |
AlertmanagerServiceApi | ListAlert | Get /ops/api/v2/alerts | list alerts of alertmanagement. |
AlertmanagerServiceApi | ListSilence | Get /ops/api/v2/silences | list silence of alertmanagement. |
AlertmanagerServiceApi | ModifySilence | Put /ops/api/v2/silence | create silence of alertmanagement. |
ContactGroupServiceApi | AddContactToGroup | Post /notification/api/v2/groups/{group}/contacts | Add contacts to group. |
ContactGroupServiceApi | CreateContactGroup | Post /notification/api/v2/groups | Create a contact group. |
ContactGroupServiceApi | DeleteContactGroup | Delete /notification/api/v2/groups/{id} | Delete a contact group. |
ContactGroupServiceApi | DescribeContactGroup | Get /notification/api/v2/groups/{id} | Describe the detail of a given contact group. |
ContactGroupServiceApi | ListContactGroup | Get /notification/api/v2/groups | List contact group. |
ContactGroupServiceApi | RemoveContactFromGroup | Delete /notification/api/v2/groups/{group}/contacts/{contact} | Remove a contact from group. |
ContactGroupServiceApi | TestContactGroup | Put /notification/api/v2/groups/{id} | Test a given contact group. |
CoreAlertServiceApi | CreateAlertRule | Post /default/api/v2/services/{service}/alerts | Create a service alert rule. |
CoreAlertServiceApi | DeleteAlertRule | Delete /default/api/v2/service/{service}/alerts/{alert} | Delete an alert rule of a service. |
CoreAlertServiceApi | DeleteAlertRuleByService | Delete /default/api/v2/service/{service}/alerts | Delete all alert rules of a service. |
CoreAlertServiceApi | DescribeAlertRule | Get /default/api/v2/services/{service}/alerts/{alert} | Describe the detail of a given alert rule. |
CoreAlertServiceApi | ListAlertRule | Get /default/api/v2/services/{service}/alerts | List the alerts of a given service. |
CoreBucketServiceApi | DescribeBucket | Get /default/api/v2/buckets/{id} | Describe the detail of a given bucket. |
CoreBucketServiceApi | ListObject | Get /default/api/v2/buckets/{bucket}/contents | List the contents of a given bucket. |
CoreCommonServiceApi | DescribeAlertConfig | Get /default/api/v2/commons/alert | Describe alert availability of system and a service. |
CoreCommonServiceApi | InitializeTenant | Post /default/api/v2/commons/tenant/onboarding | Customer onboarding |
CoreElasticIpServiceApi | AttachElasticIp | Post /default/api/v2/network/eips/{id}/attach | Attach an eip to specified instance. |
CoreElasticIpServiceApi | CreateElasticIp | Post /default/api/v2/network/eips | Create a new eip. |
CoreElasticIpServiceApi | DeleteElasticIp | Delete /default/api/v2/network/eips/{id} | release an eip. |
CoreElasticIpServiceApi | DescribeElasticIp | Get /default/api/v2/network/eips/{id} | Describe an eip detail. |
CoreElasticIpServiceApi | DetachElasticIp | Get /default/api/v2/network/eips/{id}/detach | Detach an eip from instance. |
CoreElasticIpServiceApi | ListElasticIp | Get /default/api/v2/network/eips | List all eips. |
CoreElasticIpServiceApi | ModifyElasticIpMaxBandWidth | Put /default/api/v2/network/eips/{id} | Modify maxBandWidth for specified eip. |
CoreHdfsConfigServiceApi | ActivateHdfsConfig | Put /default/api/v2/services/{service}/hdfs/{timestamp}/activation | Activate a specified hdfs configuration of a service. |
CoreHdfsConfigServiceApi | CreateHdfsConfig | Post /default/api/v2/services/{service}/hdfs | Create a service hdfs configuration. |
CoreHdfsConfigServiceApi | DeleteHdfsConfig | Delete /default/api/v2/service/{service}/hdfs/{timestamp} | Delete a hdfs configuration of a service. |
CoreHdfsConfigServiceApi | DescribeHdfsConfig | Get /default/api/v2/services/{service}/hdfs/{timestamp} | Describe the detail of a given hdfs configuration. |
CoreHdfsConfigServiceApi | ListHdfsConfig | Get /default/api/v2/services/{service}/hdfs | List the hdfs configuration of a given service. |
CoreInstanceServiceApi | DescribeInstance | Get /default/api/v2/instances/{id} | Describe the detail of a given instance. |
CoreInstanceServiceApi | ListInstance | Get /default/api/v2/instances | List all instance. |
CoreInstanceServiceApi | ListVolume | Get /default/api/v2/instances/{instance}/volumes | List all volumes of of a given instance. |
CoreInstanceTypeGroupServiceApi | CreateInstanceTypeGroup | Post /default/api/v2/instances/types/groups | Create an instance type group. |
CoreInstanceTypeGroupServiceApi | DeleteInstanceTypeGroup | Delete /default/api/v2/instances/types/groups/{name} | Delete an instance type group. |
CoreInstanceTypeGroupServiceApi | DescribeInstanceTypeGroup | Get /default/api/v2/instances/types/groups/{name} | Describe the detail of a given instance type group. |
CoreInstanceTypeGroupServiceApi | ListInstanceTypeGroup | Get /default/api/v2/instances/types/groups | List all instance type group. |
CoreInstanceTypeGroupServiceApi | UpdateInstanceTypeGroup | Put /default/api/v2/instances/types/groups/{name} | Update an instance type group. |
CoreInstanceTypeServiceApi | CreateInstanceType | Post /default/api/v2/instances/types | Create an instance type. |
CoreInstanceTypeServiceApi | DeleteInstanceType | Delete /default/api/v2/instances/types/{name} | Delete an instance type. |
CoreInstanceTypeServiceApi | DescribeInstanceType | Get /default/api/v2/instances/types/{name} | Describe the detail of a given instance type. |
CoreInstanceTypeServiceApi | DescribeInstanceTypeByComponentType | Get /default/api/v2/instances/types/component | Describe the detail of a given instance type. |
CoreInstanceTypeServiceApi | ListInstanceType | Get /default/api/v2/instances/types | List all instance type. |
CoreInstanceTypeServiceApi | UpdateInstanceType | Put /default/api/v2/instances/types/{name} | Update an instance type. |
CoreJobServiceApi | DescribeJob | Get /default/api/v2/jobs/{id} | Describe the detail of a given job. |
CoreJobServiceApi | GetJobLog | Get /default/api/v2/jobs/{id}/logs | Fetch job log. |
CoreJobServiceApi | ListJob | Get /default/api/v2/jobs | List all jobs. |
CoreNetworkInterfaceServiceApi | AttachNetworkInterface | Post /default/api/v2/network/nics/{id}/attach | Attach a nic to specified instance. |
CoreNetworkInterfaceServiceApi | CreateNetworkInterface | Post /default/api/v2/network/nics | Create a new nic. |
CoreNetworkInterfaceServiceApi | DeleteNetworkInterface | Delete /default/api/v2/network/nics/{id} | release a nic. |
CoreNetworkInterfaceServiceApi | DescribeNetworkInterface | Get /default/api/v2/network/nics/{id} | Describe an eip detail. |
CoreNetworkInterfaceServiceApi | DetachNetworkInterface | Get /default/api/v2/network/nics/{id}/detach | Detach a nic from instance. |
CoreNetworkInterfaceServiceApi | ListNetworkInterface | Get /default/api/v2/network/nics | List all nics. |
CoreOssZoneConfigServiceApi | CreateOssZoneConfig | Post /default/api/v2/oss/zones/configs | Create an object storage service configuration. |
CoreOssZoneConfigServiceApi | DeleteOssZoneConfig | Delete /default/api/v2/oss/zones/configs/{id} | Delete an object storage service configuration. |
CoreOssZoneConfigServiceApi | DescribeOssZoneConfig | Get /default/api/v2/oss/zones/configs/{id} | Describe the detail of an object storage service configuration. |
CoreOssZoneConfigServiceApi | ListOssZoneConfig | Get /default/api/v2/oss/zones/configs | List all object storage service configuration. |
CoreOssZoneConfigServiceApi | UpdateOssZoneConfig | Put /default/api/v2/oss/zones/configs/{id} | Update n object storage service configuration. |
CoreOssZoneServiceApi | CreateOssZone | Post /default/api/v2/oss/zones | Create an object storage zone. |
CoreOssZoneServiceApi | DeleteOssZone | Delete /default/api/v2/oss/zones/{name} | Delete an object storage zone. |
CoreOssZoneServiceApi | DescribeOssZone | Get /default/api/v2/oss/zones/{name} | Describe the detail of a given object storage zone. |
CoreOssZoneServiceApi | ListOssZone | Get /default/api/v2/oss/zones | List all object storage zone. |
CoreQuotaServiceApi | CreateQuota | Post /default/api/v2/quotas | Create default quota configure for given tenant. |
CoreQuotaServiceApi | ListQuota | Get /default/api/v2/quotas | List all configured quota. |
CoreQuotaServiceApi | UpdateQuota | Put /default/api/v2/quotas | Adjust quota for given tenant. |
CoreRegionConfigServiceApi | CreateRegionConfig | Post /default/api/v2/regions/configs | Create a data center region configuration. |
CoreRegionConfigServiceApi | DeleteRegionConfig | Delete /default/api/v2/regions/configs/{id} | Delete a data center region configuration. |
CoreRegionConfigServiceApi | DescribeRegionConfig | Get /default/api/v2/regions/configs/{id} | Describe the detail of a given data center region configuration. |
CoreRegionConfigServiceApi | ListRegionConfig | Get /default/api/v2/regions/configs | List all data center region configuration. |
CoreRegionConfigServiceApi | UpdateRegionConfig | Put /default/api/v2/regions/configs/{id} | Update a data center region configuration. |
CoreRegionServiceApi | CreateRegion | Post /default/api/v2/regions | Create a new data center region. |
CoreRegionServiceApi | DeleteRegion | Delete /default/api/v2/regions/{name} | Delete a data center region. |
CoreRegionServiceApi | DescribeRegion | Get /default/api/v2/regions/{name} | Describe the detail of a given data center region. |
CoreRegionServiceApi | ListRegion | Get /default/api/v2/regions | List all data center region. |
CoreResourcePoolServiceApi | AddInstanceToResourcePool | Post /default/api/v2/resources/{id}/instances | Add instances to a resource pool |
CoreResourcePoolServiceApi | CreateResourcePool | Post /default/api/v2/resources | Create a new data center zone. |
CoreResourcePoolServiceApi | DeleteInstanceFromResourcePool | Delete /default/api/v2/resources/{id}/instances/{instance} | Remove a instance from a resource pool. |
CoreResourcePoolServiceApi | DeleteResourcePool | Delete /default/api/v2/resources/{id} | Delete a data center zone. |
CoreResourcePoolServiceApi | DescribeResourcePool | Get /default/api/v2/resources/{id} | Describe the detail of a given resource pool. |
CoreResourcePoolServiceApi | ListPoolInstance | Get /default/api/v2/resources/{id}/instances | List all instances in resource pool. |
CoreResourcePoolServiceApi | ListResourcePool | Get /default/api/v2/resources | List all resource pool. |
CoreRoleServiceApi | DescribeRole | Get /default/api/v2/roles/{name} | Describe the detail of a given role. |
CoreRoleServiceApi | ListRole | Get /default/api/v2/roles | List all roles. |
CoreServiceApi | AddProjectTag | Put /default/api/v2/services/projectTag | Describe the detail of a given service. |
CoreServiceApi | CheckServiceActionPermission | Put /default/api/v2/services/{id}/action | Check if login user has permission to perform action on a given service. |
CoreServiceApi | CountService | Get /default/api/v2/services/count | count services. |
CoreServiceApi | DeleteService | Delete /default/api/v2/services/{id} | Destroy a given service. |
CoreServiceApi | DescribeService | Get /default/api/v2/services/{id} | Describe the detail of a given service. |
CoreServiceApi | DescribeTunnelInfo | Get /default/api/v2/services/tunnel | describe tunnel info of service. |
CoreServiceApi | EnableInternalCharge | Put /default/api/v2/services/enableInternalCharge | enable internal charge for service. |
CoreServiceApi | ExportServiceStateMachineDetailInfo | Get /default/api/v2/services/{id}/statemachine/info | List service and component state machine detail info. |
CoreServiceApi | InplaceUpgradeService | Post /default/api/v2/services/{service}/upgrade/inplace | Inplace upgrade service version. |
CoreServiceApi | ListBucket | Get /default/api/v2/services/{service}/buckets | List all bucket the given service has. |
CoreServiceApi | ListFaults | Get /default/api/v2/services/{id}/faults | List all faluts which service got. |
CoreServiceApi | ListMetadata | Get /default/api/v2/services/{service}/metadata | List service metadata. |
CoreServiceApi | ListMonitorService | Get /default/api/v2/services/monitor | List monitor service. |
CoreServiceApi | ListRecoveries | Get /default/api/v2/services/{id}/recoveries | List all recoveries which service got. |
CoreServiceApi | ListService | Get /default/api/v2/services | List all service. |
CoreServiceApi | ListServiceComponentHeatlhStatus | Get /default/api/v2/services/{id}/component/health | List service Component health status. |
CoreServiceApi | ListServiceDependent | Get /default/api/v2/services/{id}/dependency | List all dependencies which catalog got. |
CoreServiceApi | ListServiceFeature | Get /default/api/v2/services/{id}/features | List all features which a service support. |
CoreServiceApi | ListServiceInstance | Get /default/api/v2/services/{service}/instances | List all service instances. |
CoreServiceApi | ListServiceRecoveryDetail | Get /default/api/v2/service/recoveries/{id} | List recovery detail by recovery id. |
CoreServiceApi | ListServiceReference | Get /default/api/v2/services/{id}/reference | List all references which computing service got. |
CoreServiceApi | ListServiceStatuses | Get /default/api/v2/services/statuses | List all status of a service can be in. |
CoreServiceApi | ListTeamOfService | Get /default/api/v2/services/{service}/teams | List all teams the given service belongs to. |
CoreServiceApi | ListUnhandledFaults | Get /default/api/v2/services/{id}/unhandledfaults | List all Unhandled faults which service got. |
CoreServiceApi | ModifyChargeInfo | Put /default/api/v2/services/modifyChargeInfo/{id} | Modify Charge infomation. |
CoreServiceApi | ModifyService | Put /default/api/v2/services/{id} | Modify attribute of a service. |
CoreServiceApi | ProtectService | Get /default/api/v2/services/{id}/protect | Protect the given service from delete or stop. |
CoreServiceApi | ResetStateMachine | Get /default/api/v2/services/{id}/statemachine/reset | reset service state machine by a given service. |
CoreServiceApi | ResizeVolumes | Post /default/api/v2/services/{id}/volumes/resize | Adjust volume size of a given service. |
CoreServiceApi | RestartService | Post /default/api/v2/services/{id}/restart | Restart a service. |
CoreServiceApi | ScaleInService | Post /default/api/v2/services/{id}/scalein | Scale in a given service. |
CoreServiceApi | ScaleOutService | Post /default/api/v2/services/{id}/scaleout | Scale out a given service. |
CoreServiceApi | StartService | Post /default/api/v2/services/{id}/start | Start a service. |
CoreServiceApi | StopService | Post /default/api/v2/services/{id}/stop | Stop a service. |
CoreServiceApi | ToggleAlertAvailability | Get /default/api/v2/services/{id}/alert | Toggle alert availability. |
CoreServiceApi | ToggleAutoRecoveryAvailability | Get /default/api/v2/services/{id}/recovery | Toggle auto recovery availability. |
CoreServiceApi | UpgradeGuestAgent | Get /default/api/v2/services/{id}/guestagent/upgrade | upgrade all guest agent by a given service. |
CoreServiceApi | UpgradeService | Post /default/api/v2/services/{service}/upgrade | Upgrade service version. |
CoreServiceTypeServiceApi | ListServiceType | Get /default/api/v2/services/types | List all type of service. |
CoreServiceVersionServiceApi | CreateServiceVersion | Post /default/api/v2/services/versions | Create a new service version. |
CoreServiceVersionServiceApi | DeleteServiceVersion | Delete /default/api/v2/services/versions/{id} | Delete a service version. |
CoreServiceVersionServiceApi | DescribeServiceVersion | Get /default/api/v2/services/versions/{id} | Describe the detail of a given service version. |
CoreServiceVersionServiceApi | ListServiceVersion | Get /default/api/v2/services/versions | List all service versions. |
CoreServiceVersionServiceApi | UpdateServiceVersion | Put /default/api/v2/services/versions/{id} | Update a service version. |
CoreTeamServiceApi | AddServiceToTeam | Post /default/api/v2/teams/{team}/services | Add a service to a team |
CoreTeamServiceApi | DeleteServiceFromTeam | Delete /default/api/v2/teams/{team}/services/{service} | Remove service from a team. |
CoreTeamServiceApi | ListServiceOfTeam | Get /default/api/v2/teams/{id}/services | List all service of a team. |
CoreUnmanagedServiceApi | CreateUnmanagedService | Post /default/api/v2/services/unmanaged | Create a unmanaged service. |
CoreVendorServiceApi | ListVendor | Get /default/api/v2/vendors | List all cloud vendors. |
CoreVolumeTypeServiceApi | CreateVolumeType | Post /default/api/v2/volumes/types | Create a new volume type. |
CoreVolumeTypeServiceApi | DeleteVolumeType | Delete /default/api/v2/volumes/types/{name} | Delete a volume type. |
CoreVolumeTypeServiceApi | DescribeVolumeType | Get /default/api/v2/volumes/types/{name} | Describe the detail of a given volume type. |
CoreVolumeTypeServiceApi | ListVolumeType | Get /default/api/v2/volumes/types | List all volume type. |
CoreVpcServiceApi | ListVpc | Get /default/api/v2/vpcs | List all available vpc. |
CoreVpcServiceApi | ListVpcSubnets | Get /default/api/v2/vpcs/{vpc} | List all available subnet in a given vpc. |
CoreWarehouseServiceApi | CreateCatalog | Post /default/api/v2/services/catalog | Create a catalog service. |
CoreWarehouseServiceApi | CreateWarehouse | Post /default/api/v2/services/warehouse | Create a database service. |
CoreZoneConfigServiceApi | CreateZoneConfig | Post /default/api/v2/zones/configs | Create a data center zone configuration. |
CoreZoneConfigServiceApi | DeleteZoneConfig | Delete /default/api/v2/zones/configs/{id} | Delete a data center zone configuration. |
CoreZoneConfigServiceApi | DescribeZoneConfig | Get /default/api/v2/zones/configs/{id} | Describe the detail of a given data center zone configuration. |
CoreZoneConfigServiceApi | ListZoneConfig | Get /default/api/v2/zones/configs | List all data center zone configuration. |
CoreZoneConfigServiceApi | UpdateZoneConfig | Put /default/api/v2/zones/configs/{id} | Update a data center zone configuration. |
CoreZoneServiceApi | CreateZone | Post /default/api/v2/zones | Create a new data center zone. |
CoreZoneServiceApi | DeleteZone | Delete /default/api/v2/zones/{name} | Delete a data center zone. |
CoreZoneServiceApi | DescribeZone | Get /default/api/v2/zones/{name} | Describe the detail of a given data center zone. |
CoreZoneServiceApi | ListZone | Get /default/api/v2/zones | List all data center zone. |
MaintenanceServiceApi | ConfigThreadPool | Post /default/api/v2/system/maintenance/configure/thread-pool | Configure thread pool. |
MessageServiceApi | DescribeMessage | Get /notification/api/v2/messages/{id} | Describe the detail of a given message. |
MessageServiceApi | ListMessage | Get /notification/api/v2/messages | List all messages. |
MeteringServiceApi | StartMetering | Put /default/api/v2/services/startmetering/{id} | Service start metering. |
ResourceUsageServiceApi | CalculateResourceUsage | Get /ksyun/ccb/api/v2/tenants/configs | Calculate resource usage for configuring cluster |
ResourceUsageServiceApi | DescribeResourceUsage | Get /ksyun/ccb/api/v2/tenants/regions/{region} | Describe the resource usage of a given region. |
ResourceUsageServiceApi | ListResourceUsage | Get /ksyun/ccb/api/v2/tenants | List resource usage for all tenants. |
ServiceConfigServiceApi | CreateServiceConfig | Post /ksyun/ccb/api/v2/configs/creation | Save service configuration for creating, expanding or shrinking action. |
ServiceConfigServiceApi | DescribeServiceConfig | Post /ksyun/ccb/api/v2/configs/inquiration | Inquire result of service configuration executing |
ServiceConfigServiceApi | ExecuteServiceConfig | Post /ksyun/ccb/api/v2/configs/execution | Create, expand or shrink service by configuration |
Documentation For Models
- AccountAddUserToTeamRequest
- AccountChangePasswordRequest
- AccountComplementExternalUserAndTenantRequest
- AccountCreateClientRequest
- AccountCreateExternalTenantRequest
- AccountCreateExternalUserRequest
- AccountCreateTeamRequest
- AccountCreateTenantRequest
- AccountCreateUserRequest
- AccountDescribeClientResponse
- AccountDescribeTeamOfUserResponse
- AccountDescribeTeamResponse
- AccountDescribeTenantResponse
- AccountDescribeUserOfTeamResponse
- AccountDescribeUserResponse
- AccountListClientResponse
- AccountListTeamOfUserResponse
- AccountListTeamResponse
- AccountListTenantResponse
- AccountListUserOfTeamResponse
- AccountListUserResponse
- AccountModifyExternalTenantRequest
- AccountModifyExternalUserRequest
- AccountModifyTeamRequest
- AccountModifyUserRequest
- CloudmgrcommonIaasResource
- CloudmgrcoreIaasResource
- CommonActionResponse
- CommonDescribeJobResponse
- CommonIaasProperties
- CommonIaasResource
- CommonPriceConfig
- CommonProjectInfo
- CommonResourceConfig
- CommonResourceInfo
- CoreAddInstanceToResourcePoolRequest
- CoreAddProjectTagRequest
- CoreAddServiceToTeamRequest
- CoreAttachElasticIpRequest
- CoreAttachNetworkInterfaceRequest
- CoreCalculateDiskResponse
- CoreCalculateResourceUsageResponse
- CoreConfigThreadPoolRequest
- CoreCountServiceResponse
- CoreCreateCatalogRequest
- CoreCreateElasticIpRequest
- CoreCreateElasticNicRequest
- CoreCreateHdfsConfigRequest
- CoreCreateInstanceTypeGroupRequest
- CoreCreateInstanceTypeRequest
- CoreCreateInternetAccessRequest
- CoreCreateNetworkInterfaceRequest
- CoreCreateOssZoneConfigRequest
- CoreCreateOssZoneRequest
- CoreCreateQuotaRequest
- CoreCreateRegionConfigRequest
- CoreCreateRegionRequest
- CoreCreateResourcePoolRequest
- CoreCreateServiceComponentRequest
- CoreCreateServiceFeatureRequest
- CoreCreateServiceIaasExtraRequest
- CoreCreateServiceOssZoneRequest
- CoreCreateServiceVersionRequest
- CoreCreateUnmanagedServiceRequest
- CoreCreateVolumeTypeRequest
- CoreCreateWarehouseRequest
- CoreCreateZoneConfigRequest
- CoreCreateZoneRequest
- CoreDescribeAlertConfigResponse
- CoreDescribeBucketResponse
- CoreDescribeComponentHealthDetailResponse
- CoreDescribeComponentStateMachineStateDetailResponse
- CoreDescribeElasticIpResponse
- CoreDescribeElasticNicResponse
- CoreDescribeFaultResponse
- CoreDescribeHdfsConfigBriefResponse
- CoreDescribeHdfsConfigResponse
- CoreDescribeInstanceResponse
- CoreDescribeInstanceTypeGroupResponse
- CoreDescribeInstanceTypeResponse
- CoreDescribeInternetResponse
- CoreDescribeMetadataResponse
- CoreDescribeNetworkInterfaceResponse
- CoreDescribeNodeStateMachineStateDetailResponse
- CoreDescribeObjectResponse
- CoreDescribeOssZoneConfigResponse
- CoreDescribeOssZoneResponse
- CoreDescribeQuotaResponse
- CoreDescribeRecoveryResponse
- CoreDescribeRegionConfigResponse
- CoreDescribeRegionResponse
- CoreDescribeResourcePoolResponse
- CoreDescribeResourceUsageResponse
- CoreDescribeRoleResponse
- CoreDescribeServiceComponentResponse
- CoreDescribeServiceDependencyResponse
- CoreDescribeServiceOfTeamResponse
- CoreDescribeServiceResponse
- CoreDescribeServiceStateMachineStateDetailResponse
- CoreDescribeServiceTypeResponse
- CoreDescribeServiceVersionResponse
- CoreDescribeSubnetResponse
- CoreDescribeTeamOfServiceResponse
- CoreDescribeTunnelInfoResponse
- CoreDescribeUnhandledFaultResponse
- CoreDescribeVendorListResponse
- CoreDescribeVendorResponse
- CoreDescribeVolumeResponse
- CoreDescribeVolumeTypeResponse
- CoreDescribeVpcDomainMappingResponse
- CoreDescribeVpcResponse
- CoreDescribeWorkloadDetailResponse
- CoreDescribeZoneConfigResponse
- CoreDescribeZoneResponse
- CoreEnableInternalChargeRequest
- CoreExportServiceStateMachineInfoReponse
- CoreHost
- CoreInitializeTenantRequest
- CoreInplaceUpgradeServiceRequest
- CoreJobLogResponse
- CoreKrb5
- CoreKrb5Snippet
- CoreListElasticIpResponse
- CoreListFaultResponse
- CoreListHdfsConfigResponse
- CoreListInstanceResponse
- CoreListInstanceTypeGroupResponse
- CoreListInstanceTypeResponse
- CoreListJobResponse
- CoreListMonitorServiceResponse
- CoreListNetworkInterfaceResponse
- CoreListObjectResponse
- CoreListOssZoneConfigResponse
- CoreListOssZoneResponse
- CoreListQuotaResponse
- CoreListRecoveryResponse
- CoreListRegionConfigResponse
- CoreListRegionResponse
- CoreListResourcePoolResponse
- CoreListResourceUsageResponse
- CoreListRoleResponse
- CoreListServiceBucketResponse
- CoreListServiceComponentHealthResponse
- CoreListServiceDependencyResponse
- CoreListServiceFeatureResponse
- CoreListServiceMetadataResponse
- CoreListServiceOfTeamResponse
- CoreListServiceRecoveryDetailResponse
- CoreListServiceResponse
- CoreListServiceStatusesResponse
- CoreListServiceTypeResponse
- CoreListServiceVersionResponse
- CoreListTeamOfServiceResponse
- CoreListUnhandledFaultResponse
- CoreListVolumeResponse
- CoreListVolumeTypeResponse
- CoreListVpcDomainMappingResponse
- CoreListVpcResponse
- CoreListVpcSubnetsResponse
- CoreListWorkloadDetailResponse
- CoreListZoneConfigResponse
- CoreListZoneResponse
- CoreModifyChargeInfoRequest
- CoreModifyElasticIpMaxBandWidthRequest
- CoreModifyServiceRequest
- CoreReservedResource
- CoreResizeServiceVolumesRequest
- CoreScaleInServiceComponentRequest
- CoreScaleInServiceRequest
- CoreScaleOutIaasResource
- CoreScaleOutReservedResource
- CoreScaleOutServiceComponentRequest
- CoreScaleOutServiceRequest
- CoreStartServiceRequest
- CoreStopServiceRequest
- CoreUpdateInstanceTypeGroupRequest
- CoreUpdateInstanceTypeRequest
- CoreUpdateOssZoneConfigRequest
- CoreUpdateQuotaRequest
- CoreUpdateRegionConfigRequest
- CoreUpdateServiceVersionRequest
- CoreUpdateVersionDetailRequest
- CoreUpdateZoneConfigRequest
- CoreUpgradeServiceRequest
- CoreWorkloadTagResponse
- CoreWorkloadTextResponse
- KsyunCalculateResourceUsageResponse
- KsyunCreateServiceConfigRequest
- KsyunCreateServiceConfigResponse
- KsyunDescribeResourceUsageResponse
- KsyunDescribeServiceConfigRequest
- KsyunDescribeServiceConfigResponse
- KsyunExecuteServiceConfigRequest
- KsyunExecuteServiceConfigResponse
- KsyunListResourceUsageResponse
- NotificationAddContactToGroupRequest
- NotificationCreateContactGroupRequest
- NotificationDescribeContactGroupResponse
- NotificationDescribeContactResponse
- NotificationDescribeMessageResponse
- NotificationListContactGroupResponse
- NotificationListMessageResponse
- OpsAddCommentResponse
- OpsCallbackResponse
- OpsCountCloudmgrComponentResponse
- OpsCreateBalanceAccountResponse
- OpsCreateSilenceRequest
- OpsCreateSilenceResponse
- OpsCreateTicketResponse
- OpsCreateTransactionResponse
- OpsDescribeAggregateBillingResponse
- OpsDescribeAlertInfoResponse
- OpsDescribeAlertResponse
- OpsDescribeBalanceAccountResponse
- OpsDescribeBucketInfoResponse
- OpsDescribeCloudmgrComponentResponse
- OpsDescribeCommentResponse
- OpsDescribeMaintenanceUserResponse
- OpsDescribeOpeningBankResponse
- OpsDescribeResourcePriceResponse
- OpsDescribeSilenceResponse
- OpsDescribeTicketDetailResponse
- OpsDescribeTicketResponse
- OpsDescribeTransactionResponse
- OpsListAggregateBillingResponse
- OpsListAlertInfoResponse
- OpsListAlertResponse
- OpsListBucketInfoResponse
- OpsListCloudmgrComponentResponse
- OpsListCommentResponse
- OpsListMaintenanceUserResponse
- OpsListOpeningBankResponse
- OpsListResourcePriceResponse
- OpsListSilenceResponse
- OpsListTicketResponse
- OpsListTransactionResponse
- OpsMatcher
- OpsMeteringResource
- OpsModifySilenceRequest
- OpsModifySilenceResponse
- OpsSumBillingResponse
- VmalertCreateAlertRuleRequest
- VmalertDescribeAlertRuleResponse
- VmalertListAlertRuleResponse
Documentation For Authorization
oauth2
- Type: OAuth
- Flow: password
- Authorization URL:
- Scopes:
- ROLE_SUPERVISOR: login as supervisor
- ROLE_USER: login as user
Example
auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
Or via OAuth2 module to automatically refresh tokens and perform user authentication.
import "golang.org/x/oauth2"
/* Perform OAuth2 round trip request and obtain a token */
tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime