API の実行方法としてサービス・コンソールから実行する方法と、HTTP クライアントを使用して実行する方法があります。ここではサー ビス・コンソールからの実行する場合の特徴と実行方法を説明します。
7.1 サービス・コンソールからの API 実行方法
簡単 API 実行機能を利用して、サービス・コンソールから K5 DB(Oracle)の API を実行します。一般的な HTTP クライアントを利 用する場合と比較して以下の作業が不要となるため、簡易に API を実行できます。
・API 実行環境の準備
・API 実行時の認証に必要なトークンの取得 ・リクエストヘッダの指定
注意：実行できるのは K5 DB(Oracle)の API です。他サービスの API は実行できません。
7.1.1 API 実行画面の説明
API 実行画面のボタンや入力項目について説明します。
①
②
③
④
⑤
⑥ ⑦ ⑧
160
Copyright 2017-2019 FUJITSU LIMITED
項番 項目名 説明
① API リファレンス はこちら
「こちら」をクリックすると、FUJITSU Cloud Service K5 DB powered by Oracle○R Cloud API リファレンスが別画面で開きます。
② Method メソッド(GET、PUT、POST、DELETE)をプルダウンから選択します。
③ Body Request Body を入力します。Method に PUT または POST を選択した場合に表示されます。
④ URL API のエンドポイントです。
⑤ ― API の URL を入力します。
⑥ 「実行」ボタン 「実行」をクリックすると実行確認のポップアップが表示されます。
⑦ 「テキスト出力」
ボタン
「テキスト出力」をクリックすると、Request と Response およびヘルプデスク問合せに必要な以下 の情報がポップアップ画面に表示されます。このボタンは⑥「実行」ボタンをクリックすると活性化さ れます。
・契約番号
・アイデンティティ・ドメイン名
・アクセストークン
⑧ 「クリア」ボタン 「クリア」をクリックすると、③、⑤、Response 配下に出力される実行結果の内容がクリアされま す。
7.1.2 API 実行方法
API リファレンスの cURL コマンドの実行サンプルを利用した実行方法を説明します。実行サンプルを活用することで、パラメータ を一から入力することなく API を実行できます。
メソッドが POST、PUT の場合と GET、DELETE の場合で「API 実行」画面の構成が異なります。ここでは POST の例として
「DataPump (Import)」、GET の例として「DataPump（Import）ログ参照」を用いた実行方法を説明します。
(1)「DataPump (Import)」の実行
以下は「DataPump (Import)」の Sample cURL Command の抜粋です。Sample cURL Command の①②③ を「API 実行」画面の対応欄にコピー＆ペーストします。環境と用途に合わせて修正した上で、④「実行」ボタンをクリックしま す。
161
Copyright 2017-2019 FUJITSU LIMITED ④「実行」ボタンをクリックすると確認のダイアログが表示されます。問題なければ「OK」をクリックします。
実行結果は Response 配下に表示されます。
③
①
②
-i -X オプションで指定されているメソッドを選択します。
-d オプションの{}をコピーし、Body にペーストします。
斜体部分は可変要素です。API リファレンスの「Request Body」を元に環境と用途に合わせて修正してください。
https://・・・/api/v1 より後をコピーし、URL にペースト します。最後のシングルクォーテーションは含めません。
斜体部分は可変要素です。API リファレンスの「URL」を 元に環境と用途に合わせて修正してください。
④
API の実行結果が表示されます。コードの種類と意味は、
API リファレンスの「Return Codes」を参照ください。
API 実行結果のヘッダー情報が表示されます。
Headers に表示される項目と意味は
API リファレンスの「Response Header」を参照ください。
API 実行結果のボディ情報が表示されます。
ボディ情報が無い場合は、No body.と表示されます。
Body に表示される項目と意味は API リファレンスの
「Response Body」を参照ください。
162
Copyright 2017-2019 FUJITSU LIMITED (2)「DataPump（Import）ログ参照」の実行
以下は「DataPump（Import）ログ参照」の Sample cURL Command の抜粋です。
Sample cURL Command の赤枠で示した内容を「API 実行」画面の対応欄ににコピー＆ペーストします。環境と用途に 合わせて修正した上で、④「実行」ボタンをクリックします。
④の「実行」ボタンをクリックすると確認のダイアログが表示されます。問題なければ「OK」をクリックします。
①
②
③
-i -X オプションで指定されているメソッドを選択します。
https://・・・/api/v1 より後から?までをコピーし、URL にペースト します。
斜体部分は可変要素です。API リファレンスの「URL」を元に環境と 用途に合わせて修正してください。
?より後をコピーし、URL の２行目にペーストします。
最後のシングルクォーテーションは含めません。斜体部分は可変要素です。
アンパサンド(&)はパラメータ間の区切り文字です。
各パラメータについて API リファレンスの「Request Parameter」の説明を 参照し、斜体部分を環境と用途に合わせて修正してください。
④
163
Copyright 2017-2019 FUJITSU LIMITED 実行結果は Response 配下に表示されます。 API の実行結果が表示されます。コードの種類と意味は、
API リファレンスの「Return Codes」を参照ください。
API 実行結果のヘッダー情報が表示されます。
Headers に表示される項目と意味は API リファレ ンスの「Response Header」を参照ください。
API 実行結果のボディ情報が表示されます。
ボディ情報が無い場合は、No body.と表示されます。
Body に表示される項目と意味は API リファレンスの
「Response Body」を参照ください。
164
Copyright 2017-2019 FUJITSU LIMITED