License
Overview
ZStack Cloud is the next-generation, open-source IaaS software designed mainly for future-oriented, smart data centers. Also, it manipulates multiple data center resources of compute, storage, and network by providing flexible and comprehensive APIs. You can quickly create your own smart cloud data center by using ZStack Cloud, and set up flexible cloud usage scenarios, such as VDI, PaaS, and SaaS, on the stable ZStack Cloud.
ZStack Cloud provides multiple Authorization Protocols, including Base License and Plus License.
Base License
- Provides key basic cloud features, and meets your mainstream business needs.
- Mainly includes License ZStack Cloud Enterprise and License ZStack Cloud Hybrid.
Plus License
- Provides add-on licensed features or augmented features, and meets your specific business needs.
- Mainly includes VMware management module, migration service module, enterprise management module, backup module, BareMetal management module, ARM64 server management module, and 5x8 (7x24) after-sales service module.
Inventory
Properties
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 0.6 |
Operations
GetLicenseInfo
Obtains the license information. Sample response:
{
"inventory": {
"licenseType": "Free",
"licenseRequest": "example request",
"issuedDate": "2017-01-19 14:31:06",
"user": "example",
"hostNum": 10.0,
"expired": true,
"managementNodeUuid": "00898b3538e53e70bb7521e54ff80276"
},
"additions": []
}
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| additionSession | The additional information. The value is a JSON-formatted string. | Yes | 4.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 0.6 | |
| timeout | Yes |
ZStack Cloud allows you to obtain the ID of the Cloud by adding the platformId option to SystemTags.
- Format of the platformId option:
platformId::{%s}。{%s}represents the first 10 digits of the md5 value calculated using the request key of the Cloud. - Example:
platformId::a95d3ee34r
- Format of the platformId option:
GetLicenseRecords
Retrieves historic license authorization records. For example,
GetLicenseRecords limit=30
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| limit | The maximum number of records that cab be retrieved. Default: 20. This parameter is similar to the limit parameter in MySQL. | Yes | 4.1.0 | |
| start | The position to start a query. You need to set this parameter if you specify thelimit parameter. This parameter is similar to the offset parameter in MySQL. |
Yes | 4.1.0 | |
| replyWithCount | Specifies whether to return the number of records. If you set the value to true, the number of records are returned. | Yes | 4.1.0 | |
| count | Specifies whether to count the number of records that meet the specified conditions. This parameter is similar to the count() function. If you set the value to true, the number of records that meet the specified conditions is calculated and returned. |
Yes | 4.1.0 | |
| sortBy | Specifies to start records by a key, for example sortBy=ip. You need to specify the sortDirection parameter if you specify this parameter. This parameter is similar to the sort by parameter in MySQL. | Yes | 4.1.0 | |
| sortDirection | The sort direction. You need to set this parameter if you specify the sortByparameter. | Yes | 4.1.0 | |
| userTags | The user tags. For more information, see CreateUserTag. The resource type is VmInstanceVO. | Yes | 4.1.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 4.1.0 | |
| timeout | Yes |
GetLicenseCapabilities
Obtains a license capability. Sample response:
{{
"capabilities": {
"addHost": "true",
"clonevm": "true",
"imagestore": "true",
"ipsec": "true",
"log": "true",
"monitoring": "true",
"overProvisioning": "true",
"pciDevice": "true",
"performanceMonitor": "true",
"qos": "true",
"setVmRootPassword": "true",
"usbDevice": "true",
"vipqos": "true",
"vmware": "true",
"vrouterRoute": "true"
},
"success": true
}
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 0.6 | |
| timeout | Yes |
GetLicenseUKeyStatus
Obtains the status of the license UKey. For example,
GetLicenseUKeyStatus
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 4.7.0 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 4.7.0 |
DeleteLicense
Deletes a license file. For example,
DeleteLicense managementNodeUuid=a1b641b3cd084166a5cc79c8c5e0174c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | 0.6 | |||
| managementNodeUuids | The management node UUID list. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 0.6 | |
| timeout | Yes |
ReloadLicense
Reloads a license. For example,
ReloadLicense managementNodeUuids=a1b641b3cd084166a5cc79c8c5e0174c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| managementNodeUuids | The management node UUID list. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 0.6 | |
| timeout | Yes |
UpdateLicense
Updates the license information. For example,
UpdateLicense license=eyJwcml2YXRlSdE1...SlF5QkxSVmt0TFMwdExWeHVJbjA9In0= managementNodeUuid=a1b641b3cd084166a5cc79c8c5e0174c
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| license | The license content encoded in Base64 format. | 0.6 | ||
| additionSession | The additional information. The value is a JSON-formatted string. | Yes | 4.1.0 | |
| managementNodeUuids | The management node UUID list. | Yes | 0.6 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 0.6 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 0.6 | |
| timeout | Yes |
PushLicenseAddOnsUsage
Pushes the add-on license utilization. For example,
PushLicenseAddOnsUsage addOnsUsage=[{"usage":10,"module":"CPU.Zaku"}]
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| addOnsUsage | The utilization of each add-on license. | 5.1.8 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 5.1.8 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 5.1.8 | |
| timeout | Yes |
