Operation - Flexible InterConnect API リファレンス (2.0.0)

Download OpenAPI specification:Download

Flexible InterConnect

概要

本APIでは、Flexible InterConnectが提供するリソースの参照・操作が可能です。

オペレーションの参照操作に関するAPIドキュメントです。

Operation

List Operation

オペレーションの状態、履歴情報の一覧を取得します。

query Parameters

id	string <uuid> ^[0-9a-f]{32}$ Example: id=cc43d0f05df24b1aabdea46456d46e39 オペレーションID
resourceId	string ^F[0-9a-f]{12}$ Example: resourceId=F010123456789 契約番号
requestType	string Enum: "Create" "Update" "Delete" "Activate" "Deactivate" Example: requestType=Delete 種別 ‘Create/Update/Delete/Activate/Deactivate’のいずれか
status	string Enum: "Processing" "Completed" "Cancelled" Example: status=Completed ステータス ‘Processing/Completed/Cancelled’のいずれか
offset	integer ( 0 .. 10000 ) Example: offset=10000 オフセット（0～10000まで）デフォルト値:0
limit	integer ( 1 .. 100 ) Example: limit=100 リミット（1～100まで）デフォルト値:100

header Parameters

Content-Type required	string Value: "application/json"
X-Auth-Token required	string ^[0-9a-f]{32}$ Example: dc03494823a841338430052e9ee95e07 クライアントが Keystone を利用して取得した認証 Token

Responses

200

OK 成功しました

400

Bad Request リクエストが不正

401

Unauthorized 認証エラー

409

Conflict 競合エラー

get/v1/operations

https://api.ntt.com/fic-eri/v1/operations

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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": ""
}
]
}

Show Operation

オペレーションの状態、履歴の詳細情報を取得します。

path Parameters

operation-id

required

string