Top
ServerView Resource Orchestrator Cloud Edition V3.2.0 Reference Guide (API)
FUJITSU Software

2.2.4 DestroyNetwork (Delete a Specified Network Segment from an L-Platform)

This API deletes a specified network segment from an L-Platform.

Request parameters

Parameter name

Item

Item description

Version

Description

The version ID of the L-Platform API.

Type

string

Value

Fixed. Specify "2.0".

Locale

Description

The language for communicating with the L-Platform API. This parameter is specified using the language codes stipulated by ISO 639.

Type

string

Value

Select one of the following:
- en: English
- zh: Chinese

Action

Description

The user ID of the user that executes the L-Platform API.

Type

string

Value

Fixed. Specify "DestroyNetwork ".

userId

Description

The user ID of the user that executes the L-Platform API.

Type

string

Value

No more than 31 characters.

orgId

Description

The tenant name of the user that executes the L-Platform API.

Type

string

Value

No more than 32 characters.

lplatformId

Description

ID of the L-Platform from which the network is to be deleted.

Type

string

Value

No more than 32 characters.

networkId

Description

Network ID to be deleted.

Type

string

Value

No more than 32 characters.


Response

<Status code>

The API returns "200 OK" if it terminates normally.


<XML>

<?xml version="1.0" encoding="UTF-8"?>
 <DestroyNetworkResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>[Message]</responseMessage>
  <responseStatus>[Status]</responseStatus>
</DestroyNetworkResponse>

<Elements>

Element name

Item

Item description

DestroyNetworkResponse

Description

Element holding the response information.

Type

None

Number of occurrences

1

responseMessage

Description

Message. This element indicates whether the request has been processed correctly.
Refer to "Chaper 15 Messages Starting with PAPI" in the "Messages" for message details.

Type

string

Number of occurrences

1

responseStatus

Description

Status. This element indicates whether the request has been processed normally. "SUCCESS" is returned if the request is processed normally. Otherwise, an error code is returned.
Refer to "Appendix A List of Response Status Error Codes(L-Platform APIs)" for information on error codes.

Type

string

Number of occurrences

1.


Sample response

<?xml version="1.0" encoding="UTF-8"?>
 <DestroyNetworkResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com">
  <responseMessage>PAPI00000 Processing was completed.</responseMessage>
  <responseStatus>SUCCESS</responseStatus>
</DestroyNetworkResponse>