ZStack ZSphere Documentation
All Version
All
ZStack ZSphere Documentation>ZSphere API Reference(v5.0.0)>Network Management>Network Services
Get PDF

GetNetworkServiceTypes

API Request

URLs
GET zstack/v1/network-services/types
Headers
Authorization: OAuth the-session-uuid
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 8a5a05acd4fb47b7839a9c50a74c3f1a" \ -X GET http://localhost:8080/zstack/v1/network-services/types
Parameter List
Name Type Location Description Allowed Values Starting Version
systemTags (Optional) List query System tags 0.6
userTags (Optional) List query User tags 0.6

API Response

Response Example
{ "serviceAndProviderTypes": { "SecurityGroup": [ "929ae57afd1b4815b04ecb25bd67fb02"     ]   } }
Name Type Description Starting Version
types Map 0.6
error ErrorCode Error code. If not null, the operation failed. If null, the operation succeeded. See error for details. 0.6
#error
Name Type Description Starting Version
code String Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, defaults to null 0.6
opaque LinkedHashMap Reserved field, defaults to null 0.6
cause ErrorCode Root error: the source error that caused the current error. If there is no original error, this field is null 0.6

SDK Examples

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 Request

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

Queryable Fields

Run the CLI tool, type QueryNetworkServiceProvider and press the Tab key to view all queryable fields and cross-table queryable resource names.

API Response

Response Example
{ "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": []     }   ] }
Name Type Description Starting Version
error ErrorCode Error code. If not null, the operation failed. If null, the operation succeeded. Seeerror for details. 0.6
inventories List Seeinventories for details. 0.6
#error
Name Type Description Starting Version
code String Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, defaults to null 0.6
opaque LinkedHashMap Reserved field, defaults to null 0.6
cause ErrorCode Root error: the source error that caused the current error. If there is no original error, this field is null 0.6
#inventories
Name Type Description Starting Version
uuid String The UUID of the resource, uniquely identifying the resource 0.6
name String The resource name 0.6
description String The detailed description of the resource 0.6
type String 0.6
createDate Timestamp The creation time 0.6
lastOpDate Timestamp The last modification time 0.6
networkServiceTypes Set 0.6
attachedL2NetworkUuids Set 0.6

SDK Examples

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 Request

URLs
GET zstack/v1/l3-networks/network-services/refs
Headers
Authorization: OAuth the-session-uuid
Curl Example
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

Queryable Fields

Run the CLI tool, type QueryNetworkServiceL3NetworkRef and press the Tab key to view all queryable fields and cross-table queryable resource names.

API Response

Response Example
{ "inventories": [     { "l3NetworkUuid": "fc5bd613a8fd45ed9b96ff5d99ae6717", "networkServiceProviderUuid": "f79573afadc44f4fb83aaf67eeb98cde", "networkServiceType": "PortForwarding"     }   ] }
Name Type Description Starting Version
error ErrorCode Error code. If not null, the operation failed. If null, the operation succeeded. See error 0.6
inventories List See inventories 0.6
#error
Name Type Description Starting Version
code String Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, defaults to null 0.6
opaque LinkedHashMap Reserved field, defaults to null 0.6
cause ErrorCode Root error: the source error that caused the current error. If there is no original error, this field is null 0.6
#inventories
Name Type Description Starting Version
l3NetworkUuid String The Distributed Port Group UUID 0.6
networkServiceProviderUuid String The network service provider UUID 0.6
networkServiceType String 0.6

SDK Examples

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()
























Archives

Download Document Archives

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Cannot be empty.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.
同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.