硬件设施

创建区域(CreateZone)

API请求

URLs

POST zstack/v1/zones

Headers

Authorization: OAuth the-session-uuid

Body

{ "params": { "name": "TestZone", "description": "test zone"   }, "systemTags": [], "userTags": [] }

说明: 上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"TestZone","description":"test zone"}}' \ http://localhost:8080/zstack/v1/zones

参数列表

名字	类型	位置	描述	起始版本
name	String	body(包含在params结构中)	资源名称	0.6
description (可选)	String	body(包含在params结构中)	资源的详细描述	0.6
resourceUuid (可选)	String	body(包含在params结构中)	用户指定的资源uuid	0.6
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.6

API返回

返回示例

{ "inventory": { "uuid": "0d26522305c34d07b5661ccda62053c0", "name": "TestZone", "description": "Test", "state": "Enabled", "type": "zstack", "createDate": "Jun 7, 2017 9:20:28 PM", "lastOpDate": "Jun 7, 2017 9:20:28 PM"   } }

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventory	ZoneInventory	详情参考inventory	0.6

#error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

#inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	0.6
name	String	资源名称	0.6
description	String	资源的详细描述	0.6
state	String		0.6
type	String		0.6
createDate	Timestamp	创建时间	0.6
lastOpDate	Timestamp	最后一次修改时间	0.6

SDK示例

Java SDK

CreateZoneAction action = new CreateZoneAction(); action.name = "TestZone"; action.description = "test zone"; action.sessionId = "982a09118de64ef7a9051fde346270c5"; CreateZoneAction.Result res = action.call();

Python SDK

CreateZoneAction action = CreateZoneAction() action.name = "TestZone" action.description = "test zone" action.sessionId = "79e260dca17b4bdf9b7d7b4e150883df" CreateZoneAction.Result res = action.call()

删除区域(DeleteZone）

API请求

URLs

DELETE zstack/v1/zones/{uuid}?deleteMode={deleteMode}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 05fc0a34be264877a9dc8dfb5f90d619" \ -X DELETE http://localhost:8080/zstack/v1/zones/d3483ca440334af3acc09d8631e814c6?deleteMode=Permissive

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	0.6
deleteMode (可选)	String	body	Permissive：如果删除过程中发生错误或者删除不被允许，云平台会停止删除操作；在这种情况下, 包含失败原因的错误代码会被返回。 Enforcing：云平台会忽略所有错误和权限而直接删除资源；在这种情况下, 删除操作总是会成功。	0.6
systemTags (可选)	List	body	系统标签	0.6
userTags (可选)	List	body	用户标签	0.6

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{ "error": { "code": "SYS.1001", "description": "A message or a operation timeout", "details": "Create VM on KVM timeout after 300s"     } }

SDK示例

Java SDK

DeleteZoneAction action = new DeleteZoneAction(); action.uuid = "8987020fccd14191a5a89dda6f3db81e"; action.deleteMode = "Permissive"; action.sessionId = "835b1b72c4554a7e92c425ad9eaebc6d"; DeleteZoneAction.Result res = action.call();

Python SDK

DeleteZoneAction action = DeleteZoneAction() action.uuid = "a4bcb439c99a42e197cac90be83e706e" action.deleteMode = "Permissive" action.sessionId = "6eaf02e52c884e378a3730ce4267d83a" DeleteZoneAction.Result res = action.call()

升级提醒

若您选择升级至4.0.0及之后版本，请注意以下功能调整：

1. 云路由器全面升级为VPC路由器，云路由网络全面升级为VPC网络，不再单独设云路由器页面。升级全程无感知，相关业务不受任何影响。

2. 企业管理账号体系取代用户组与用户，不再单独设用户/用户组页面，不可再使用用户/用户组账号登录云平台。升级前，请先将“用户组与用户”纳管的账号数据妥善迁移至“企业管理”纳管，再执行升级操作。注意：对于admin创建并具备admin权限的用户账号同步取消，如有需要，可使用企业管理账号体系中的平台管理员实现相同功能。

3. 调整AD/LDAP与账户的对接管理方式，统一由企业管理纳管，不再单独设AD/LDAP页面。升级前，请先将“账户”对接纳管的AD/LDAP账号数据妥善迁移至“企业管理”纳管，再执行升级操作。

如对上述升级提醒有任何疑问或需要升级帮助，请联系ZStack官方技术支持

区域相关接口

创建区域(CreateZone)

API请求

API返回

SDK示例

删除区域(DeleteZone）

API请求

API返回

SDK示例

客户评论

撰写评论

产品

解决方案

支持

联系