ZStack Cloud Platform
Single Server, Free Trial for One Year
-
Documentation&Tools
Comprehensive product documentation and tools
-
Support & Services
Upholding the value of Customer First and the mission of Serving Customer, ZStack is dedicated to providing secure and stable services for customers.
-
Training & Certification
To educate ZStack partners and interested individuals about cloud computing and to cultivate cloud computing talent.
-
Content
ZStack provides innovative cloud infrastructure for ten major industries
VMware-to-ZStack Case Collection
The report provides three major
solutions and customer case studies for transitioning from VMware to ZStack.
System Error Code Operations
GetElaborations
API Request
URLs
GET zstack/v1/errorcode/elaborationsHeaders
Authorization: OAuth the-session-uuidCurl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X GET http://localhost:8080/zstack/v1/errorcode/elaborations?category=BS®ex=certificate has expired or is not yet validRequest Parameters
| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| category | String | query | Optional. The error code category, which is consistent with resource or service category, such as HOST. | 3.3.0 | |
| regex | String | query | Optional. The error code keyword. | 3.3.0 | |
| code | String | query | Optional. The error code, which is used with the error code category. | 3.6.0 | |
| systemTags | List | query | Optional. The system tags. | 3.3.0 | |
| userTags | List | query | Optional. The user tags. | 3.3.0 |
API Response
Sample Response
{ "contents": [ { "category": "HOST", "code": "1003", "regex": "host[uuid:%s, name:%s] is in status[%s], cannot perform required operation", "message_cn": "物理机正处于[停止]状态，不能进行该操作", "message_en": "Host is in status[Stopped], cannot perform required operation", "source": "zstack", "method": "distance", "distance": 0.0 } ] }| Name | Type | Description | Starting Version |
|---|---|---|---|
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error. | 3.3.0 |
| contents | List | See contents. | 3.3.0 |
#error
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 0.6 |
| description | String | The brief description of the error. | 0.6 |
| details | String | The details about the error. | 0.6 |
| elaboration | String | The reserved field. Default value: null. | 0.6 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 0.6 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 0.6 |
#contents
| Name | Type | Description | Starting Version |
|---|---|---|---|
| category | String | The error code category. | 3.3.0 |
| code | String | The error code. | 3.3.0 |
| regex | String | The error code keyword. | 3.3.0 |
| message_cn | String | The error code message in Chinese. | 3.3.0 |
| message_en | String | The error code message in English. | 3.3.0 |
| source | String | The source of the error. | 3.3.0 |
| method | String | The matching method, including distance (string comparison) and regex (regular expression). | 3.6.0 |
| distance | Double | If you use distance to do the match, this parameter will be the precision. Note: '1' is the best precision. | 3.6.0 |
SDK Sample
Java SDK
GetElaborationsAction action = new GetElaborationsAction(); action.category = "BS"; action.regex = "certificate has expired or is not yet valid"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; GetElaborationsAction.Result res = action.call();Python SDK
GetElaborationsAction action = GetElaborationsAction() action.category = "BS" action.regex = "certificate has expired or is not yet valid" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" GetElaborationsAction.Result res = action.call()GetElaborationCategories
API Request
URLs
GET zstack/v1/errorcode/elaborations/categoriesHeaders
Authorization: OAuth the-session-uuidCurl Sample
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X GET http://localhost:8080/zstack/v1/errorcode/elaborations/categoriesRequest Parameters
| Name | Type | Location | Description | Valid Value | Starting Version |
|---|---|---|---|---|---|
| systemTags | List | query | Optional. The system tags. | 4.5.0 | |
| userTags | List | query | Optional. The user tags. | 4.5.0 |
API Response
Sample Response
{ "categories": [ { "category": "ACCOUNT", "num": 5.0 }, { "category": "BS", "num": 3.0 }, { "category": "VM", "num": 20.0 } ] }| Name | Type | Description | Starting Version |
|---|---|---|---|
| error | ErrorCode | The error code. If not null, the operation fails, or vice versa. For more information, see error | 4.5.0 |
| categories | List | For more information, see categories | 4.5.0 |
#error
| Name | Type | Description | Starting Version |
|---|---|---|---|
| code | String | The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001. | 4.5.0 |
| description | String | The brief description of the error. | 4.5.0 |
| details | String | The details about the error. | 4.5.0 |
| elaboration | String | The reserved field. Default value: null. | 4.5.0 |
| opaque | LinkedHashMap | The reserved field. Default value: null. | 4.5.0 |
| cause | ErrorCode | The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null. | 4.5.0 |
#categories
| Name | Type | Description | Starting Version |
|---|---|---|---|
| category | String | The category name. | 4.5.0 |
| num | Integer | The count of the error codes under the category. | 4.5.0 |
SDK Sample
Java SDK
GetElaborationCategoriesAction action = new GetElaborationCategoriesAction(); action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; GetElaborationCategoriesAction.Result res = action.call();Python SDK
GetElaborationCategoriesAction action = GetElaborationCategoriesAction() action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" GetElaborationCategoriesAction.Result res = action.call()Next Chapter: Search Operations