Operation - Flexible Secure Gateway API References (1.10.0)

Download OpenAPI specification:Download

Operation is a resource of operation history.

Authentication

X-Auth-Token

Security Scheme Type	API Key
Header parameter name:	{keystone_token}

operation

Get Operation

Get Operation Resources.

Authorizations:

X-Auth-Token

query Parameters

id	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the Operation.
resourceId	string The ID of resource the operation applied.
resourceType	string A type of resource the operation applied.
requestType	string A type of request.
status	string A status of the operation.
cellGroupId	string The Cell-Group ID which the resource belongs.
configVersion	string Updated ConfigVersion by the operation.
configVersionFrom	string Only config histories whose version is bigger than that of user specified.
configVersionTo	string Only config histories whose version is smaller than that of user specified.
tenantId	string The tenant ID which the resource belongs.
limit	integer Maximum number of listed items.
offset	integer The offset number of listed items.
order_by	Array of strings Items Enum: "id" "resourceId" "resourceType" "requestType" "tenantId" "requestBody" "receptionTime" "commitTime" "error" "status" "cellGroupId" "configVersion" Sort keys.

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1/operations

https://api.ntt.com/dsigw-erg/v1/operations

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"operations": 
[
{"id": "e99cde8d-0ae3-443a-9cd8-9b3f9fe8930f",
"resourceId": "c809bc04-7149-4f6d-96fb-19ee36e53518",
"resourceType": "CellGroup",
"requestType": "UPDATE",
"requestBody": "{\"cellGroup\": {\"name\": \"test\", \"dnsDomain\": \"test.com\", \"dnsHostname\": \"test\", \"dnsTimeToLive\": 10, \"staticRoutes\": [], \"logForward\": [{\"destinationIp\": \"10.0.0.1\", \"destinationPort\": 8080, \"protocol\": \"tcp\", \"logHeaderFormat\": \"bsd\", \"logMessageFormat\": \"csv\", \"logTypes\": [\"traffic\"]}]}}",
"tenantId": "d94e61c650fb4609987fbab771743b61",
"receptionTime": "2021-07-28T05:12:00Z",
"commitTime": "2021-07-28T05:12:00Z",
"warnings": [ ],
"error": "",
"status": "COMPLETE",
"cellGroupId": "c809bc04-7149-4f6d-96fb-19ee36e53518",
"configVersion": 349
},
{"id": "664d30cb-bd25-4544-83e7-3b383c1d7a0d",
"resourceId": "c809bc04-7149-4f6d-96fb-19ee36e53518",
"resourceType": "CellGroup",
"requestType": "UPDATE",
"requestBody": "{\"cellGroup\": {\"name\": \"test\", \"dnsDomain\": \"test.com\", \"dnsHostname\": \"test\", \"dnsTimeToLive\": 10, \"staticRoutes\": [], \"logForward\": [{\"destinationIp\": \"10.0.0.1\", \"destinationPort\": 8080, \"protocol\": \"tcp\", \"logHeaderFormat\": \"bsd\", \"logMessageFormat\": \"csv\", \"logTypes\": [\"traffic\"]}]}}",
"tenantId": "d94e61c650fb4609987fbab771743b61",
"receptionTime": "2021-07-28T05:11:57Z",
"commitTime": "2021-07-28T05:11:57Z",
"warnings": [ ],
"error": "",
"status": "COMPLETE",
"cellGroupId": "c809bc04-7149-4f6d-96fb-19ee36e53518",
"configVersion": 348
}
]
}

Get Operation Details

Get a Operation Resource.

Authorizations:

X-Auth-Token

path Parameters

operation_id

required

string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

The ID of the Operation.

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/operations/{operation_id}

https://api.ntt.com/dsigw-erg/v1/operations/{operation_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"operation": 
{"id": "e99cde8d-0ae3-443a-9cd8-9b3f9fe8930f",
"resourceId": "c809bc04-7149-4f6d-96fb-19ee36e53518",
"resourceType": "CellGroup",
"requestType": "UPDATE",
"requestBody": "{\"cellGroup\": {\"name\": \"test\", \"dnsDomain\": \"test.com\", \"dnsHostname\": \"test\", \"dnsTimeToLive\": 10, \"staticRoutes\": [], \"logForward\": [{\"destinationIp\": \"10.0.0.1\", \"destinationPort\": 8080, \"protocol\": \"tcp\", \"logHeaderFormat\": \"bsd\", \"logMessageFormat\": \"csv\", \"logTypes\": [\"traffic\"]}]}}",
"tenantId": "d94e61c650fb4609987fbab771743b61",
"receptionTime": "2021-07-28T05:12:00Z",
"commitTime": "2021-07-28T05:12:00Z",
"warnings": [ ],
"error": "",
"status": "COMPLETE",
"cellGroupId": "c809bc04-7149-4f6d-96fb-19ee36e53518",
"configVersion": 349
}
}