网络服务

ZStack ZSphere 4.2.6>ZStack ZSphere产品文档>ZStack ZSphere 开发手册>网络管理>网络服务

获取网络服务类型(GetNetworkServiceTypes)

API请求

URLs

GET zstack/v1/network-services/types

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 8a5a05acd4fb47b7839a9c50a74c3f1a" \ -X GET http://localhost:8080/zstack/v1/network-services/types

参数列表

名字	类型	位置	描述	可选值	起始版本
systemTags (可选)	List	query	系统标签		0.6
userTags (可选)	List	query	用户标签		0.6

API返回

返回示例

{ "serviceAndProviderTypes": { "SecurityGroup": [ "929ae57afd1b4815b04ecb25bd67fb02"     ]   } }

名字	类型	描述	起始版本
types	Map		0.6
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	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

SDK示例

Java SDK

GetNetworkServiceTypesAction action = new GetNetworkServiceTypesAction(); action.sessionId = "bcb01c0891bb48a1974e2004b3397678"; GetNetworkServiceTypesAction.Result res = action.call();

Python SDK

GetNetworkServiceTypesAction action = GetNetworkServiceTypesAction() action.sessionId = "35c50339c05b4d6c9b4461a478c17239" GetNetworkServiceTypesAction.Result res = action.call()

查询网络服务模块(QueryNetworkServiceProvider)

API请求

URLs

GET zstack/v1/network-services/providers

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 0305524eb18344ea95193f8283a7212f" \ -X GET http://localhost:8080/zstack/v1/network-services/providers

可查询字段

运行CLI命令行工具，输入QueryNetworkServiceProvider并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{ "inventories": [     { "uuid": "3cf04a2c5e1a4c4c8947545323e35d6a", "name": "SecurityGroup", "type": "SecurityGroup", "createDate": "Jun 7, 2017 9:21:03 PM", "lastOpDate": "Jun 7, 2017 9:21:03 PM", "networkServiceTypes": [ "SecurityGroup"       ], "attachedL2NetworkUuids": []     }   ] }

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventories	List	详情参考inventories	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

#inventories

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

SDK示例

Java SDK

QueryNetworkServiceProviderAction action = new QueryNetworkServiceProviderAction(); action.conditions = asList(); action.sessionId = "3d4bfef1a32241528160058368824670"; QueryNetworkServiceProviderAction.Result res = action.call();

Python SDK

QueryNetworkServiceProviderAction action = QueryNetworkServiceProviderAction() action.conditions = [] action.sessionId = "db50128c5ab745e68c9b30c52d24ebf9" QueryNetworkServiceProviderAction.Result res = action.call()

查询网络服务与分布式端口组引用(QueryNetworkServiceL3NetworkRef)

API请求

URLs

GET zstack/v1/l3-networks/network-services/refs

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth aa530ebc39804e00b3df02b8862eaec3" \ -X GET http://localhost:8080/zstack/v1/l3-networks/network-services/refs

可查询字段

运行CLI命令行工具，输入QueryNetworkServiceL3NetworkRef并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{ "inventories": [     { "l3NetworkUuid": "fc5bd613a8fd45ed9b96ff5d99ae6717", "networkServiceProviderUuid": "f79573afadc44f4fb83aaf67eeb98cde", "networkServiceType": "PortForwarding"     }   ] }

名字	类型	描述	起始版本
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	0.6
inventories	List	详情参考inventories	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

#inventories

名字	类型	描述	起始版本
l3NetworkUuid	String	分布式端口组UUID	0.6
networkServiceProviderUuid	String	网络服务提供模块UUID	0.6
networkServiceType	String		0.6

SDK示例

Java SDK

QueryNetworkServiceL3NetworkRefAction action = new QueryNetworkServiceL3NetworkRefAction(); action.conditions = asList(); action.sessionId = "01368722cb7e4c7eac03e7040f8b73e1"; QueryNetworkServiceL3NetworkRefAction.Result res = action.call();

Python SDK

QueryNetworkServiceL3NetworkRefAction action = QueryNetworkServiceL3NetworkRefAction() action.conditions = [] action.sessionId = "237996a7dddf4cf3a42f6ea15893bc76" QueryNetworkServiceL3NetworkRefAction.Result res = action.call()