1. Show Operation

1.1. Overview

Operationの状態、履歴の詳細情報を取得します。

1.2. Classification

  • Get

1.3. API Operation Object

  • Operation

1.4. Synchronous / Asynchronous

  • Synchronous

1.5. Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/fic-eri/v1/operations/{operation_id}

HTTP Request Header

Format

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

HTTP Request Body

none

Request Parameter

item mandatory format enum description
operation_id string   対象オペレーションID

1.6. Response

HTTP Response Header

Format

HTTP/1.1 <response_code> <message>       (ex. 200 OK)

Response Code

response code condition
200 成功しました
400 リクエストが不正
401 認証エラー
404 未検出エラー
409 競合エラー

HTTP Response Body

Format

{
    "operation": {
        "id": "cc43d0f05df24b1aabdea46456d46e39",
        "tenantId": "9d6a6682f0044660beae9701624e5dc4",
        "resourceId": "F0n0123456789",
        "resourceName": "YourResourceName",
        "resourceType": "Router",
        "requestType": "Delete",
        "status": "Completed",
        "receptionTime": "2020-07-24T06:16:46Z",
        "commitTime": "2020-07-24T06:16:49Z",
        "error": "",
        "requestBody": ""
    }
}

Response Parameter

item format description
operation.id string オペレーションID
operation.tenantId string テナントID
operation.resourceId string
契約番号
F+半角数字12桁

‘port_id/connection_id/firewall_id’など

operation.resourceName string
名前

operation実行時のリソース名

operation.resourceType string
内容

‘Port/NAT/Router-to-AWS-Connection’など

operation.requestType string
種別

‘Create/Update/Delete/Activate/Deactivate’のいずれか

operation.status string
ステータス

‘Processing/Completed/Cancelled’のいずれか

operation.receptionTime string
受付日時

utc, RFC3339

operation.commitTime string
完了日時
utc, RFC3339

終了前はnull

operation.error string エラー内容
operation.requestBody string リクエスト内容

2. List Operations

2.1. Overview

Operationの状態、履歴情報の一覧を取得します。

2.2. Classification

  • List

2.3. API Operation Object

  • Operation

2.4. Synchronous / Asynchronous

  • Synchronous

2.5. Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/fic-eri/v1/operations

HTTP Request Header

Format

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

HTTP Request Body

none

Request Parameter

item mandatory format enum description
none        

Query Parameter

item mandatory format enum description
id   string   オペレーションID
resourceId   string   契約番号
requestType   string
Create
Update
Delete
Activate

Deactivate

種別

‘Create/Update/Delete/Activate/Deactivate’のいずれか

status   string
Processing
Completed

Cancelled

ステータス

‘Processing/Completed/Cancelled’のいずれか

offset   number  
オフセット(0~10000まで)

デフォルト値:0

limit   number  
リミット(1~100まで)

デフォルト値:100

2.6. Response

HTTP Response Header

Format

HTTP/1.1 <response_code> <message>       (ex. 200 OK)

Response Code

response code condition
200 成功しました
400 リクエストが不正
401 認証エラー
409 競合エラー

HTTP Response Body

Format

{
    "operations": [
        {
            "id": "cc43d0f05df24b1aabdea46456d46e39",
            "tenantId": "9d6a6682f0044660beae9701624e5dc4",
            "resourceId": "F0n0123456789",
            "resourceName": "YourResourceName",
            "resourceType": "Router",
            "requestType": "Delete",
            "status": "Completed",
            "receptionTime": "2020-07-24T06:16:46Z",
            "commitTime": "2020-07-24T06:16:49Z",
            "error": "",
            "requestBody": ""
        }
    ]
}

Response Parameter

item format description
operations.id string オペレーションID
operations.tenantId string テナントID
operations.resourceId string
契約番号
F+半角数字12桁

‘port_id/connection_id/firewall_id’など

operations.resourceName string
名前

operation実行時のリソース名

operations.resourceType string
内容

‘Port/NAT/Router-to-AWS-Connection’など

operations.requestType string
種別

‘Create/Update/Delete/Activate/Deactivate’のいずれか

operations.status string
ステータス

‘Processing/Completed/Cancelled’のいずれか

operations.receptionTime string
受付日時

utc, RFC3339

operations.commitTime string
完了日時
utc, RFC3339

終了前はnull

operations.error string エラー内容
operations.requestBody string リクエスト内容