Create HA Constitution Device¶

Overview¶

Create new Managed Firewall/UTM devices of HA constitution.

API Operation Object¶

Managed Firewall/UTM HA constitution devices

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

POST

HTTP Request Path¶

{endpoint}/API/SoEntryFGHA

HTTP Request Header¶

X-Auth-Token: <token_id>
Content-Type: application/json

Request Parameter¶

Request Parameters¶
item	Required	type	format	description
sokind	yes	String	-	AH: Create HA Constitution Device
tenant_id	yes	String	UUID	Tenant ID of the owner (UUID)
locale	no	String	-	Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is "en".
gt_host	yes	list	-
operatingmode	yes	String	-	Set "UTM_HA" or "FW_HA" to this value.
licensekind	yes	String	-	Set "02" or "08" as Managed FW/UTM plan.
azgroup	yes	String	-	Availability Zone.
halink1networkid	yes	String	hyph-uuid	Set the Network ID to be used for HA line.
halink1subnetid	yes	String	hyph-uuid	Set the Subnet ID to be used for HA line.
halink1ipaddress	yes	String	-	Set value of IPv4
halink2networkid	yes	String	hyph-uuid	Set the Network ID to be used for HA line.
halink2subnetid	yes	String	hyph-uuid	TSet the Subnet ID to be used for HA line.
halink2ipaddress	yes	String	-	Set value of IPv4

Sample Request Body¶

{
   "tenant_id": "dbb65792d77d45a38da3d62b1350e6df",
   "sokind": "AH",
   "locale": "ja",
   "gt_host": [{
       "operatingmode": "UTM_HA",
       "licensekind": "02",
       "azgroup": "zone1-groupa",
       "halink1networkid": "f744e2f7-24a1-46ef-a4c0-90db479d1046",
       "halink1subnetid": "aea80a45-0366-4077-9761-20758c990274",
       "halink1ipaddress": "192.168.10.2",
       "halink2networkid": "6c3e1b2c-e377-49bf-aafc-5b490fc316d9",
       "halink2subnetid": "f4613a1c-0629-4816-9b14-34086ae7f59c",
       "halink2ipaddress": "192.169.10.5"
   },{
       "operatingmode": "UTM_HA",
       "licensekind": "02",
       "azgroup": "zone1-groupb",
       "halink1networkid": "f744e2f7-24a1-46ef-a4c0-90db479d1046",
       "halink1subnetid": "aea80a45-0366-4077-9761-20758c990274",
       "halink1ipaddress": "192.168.10.3",
       "halink2networkid": "6c3e1b2c-e377-49bf-aafc-5b490fc316d9",
       "halink2subnetid": "f4613a1c-0629-4816-9b14-34086ae7f59c",
       "halink2ipaddress": "192.169.10.6"
   }]
}

Response¶

HTTP Response Code¶

Response Codes¶
Response Code	Description
200	OK
400	Request format is invalid
401	Unauthorized
500	Internal Server Error
511	Internal Server Error (Fail Service Order etc.)

Response Parameter¶

Response Parameters¶
item	type	format	description
code	String	-	This code is for determining the details of the error.FOV-H-: Successful Completion. FOV-H-E: Error has occurred.
message	String	-	This message is shown when error has occurred.
soId	String	-	Identification ID of Service Order.
status	integer	-	This value indicates normal or abnormal. 1:normal, 2:abnormal

Sample Response Body¶

Normal Response¶

When locale is "ja"

{
    "code": "FOV-H-OK",
    "message": "正常終了",
    "soId": "FGHA_FT64D7781E8541B298FCFE418909B44C0",
    "status": 1
}

When locale is "en"

{
    "code": "FOV-H-OK",
    "message": "Successful completion",
    "soId": "FGHA_FT64D7781E8541B298FCFE418909B44C0",
    "status": 1
}

Error Response¶

When locale is "ja"

{
    "code": "FOV-H-E",
    "message": "システムエラーが発生しました。恐れ入りますが、チケットシステムでご連絡ください。",
    "status": 2
}

When locale is "en"

{
    "code": "FOV-H-E",
    "message": "System error has occurred. Excuse me, please contact us at the ticket system.",
    "status": 2
}

List Single Constitution Devices

Update HA Constitution Device