KCPS2 API切り分けについて

KDDI
Ver1.0API実行時の確認フロー
開始

NG：エラー応答あり

kick_api.shにてAPI
コマンド実行

エラーコード
401エラーYes

Yes

kick_api.shのKey情報が正しく設定されているか確認してください。
（開発者ガイドのAPI利用準備参照）

Yes

kick_api.shのAPIコマンド名が誤っていないか確認してください。
（開発者ガイドの提供API一覧参照）

No

OK：エラー応答無APIコマンドが内容通りの動作だったか？

エラーコード403エラーNGNo

OK
AdminConsole
画面からの操作は正常動作したか？

NG

KDDI調査依頼（APIの問題）(実行APIと画面操作を明確にした上で、KDDIに問い合わせください。）

Yes

kick_api.shのAPIコマンドの引数が誤っていないか確認してください。
（開発者ガイドのAPIリファレンス参照）

NoOK
お客さまのAPI実装
プログラムの問題。
お客さまにて、プログラムの解析を行ってください。

エラーコード300,431,500,
530,531
エラー

KDDI調査依頼（設備の問題）(実行APIと画面操作を明確にした上で、KDDIに問い合わせください。）

応答
タイムアウト2

Yes

ネットワーク疎通が取れていない可能性があるため、お客様環境のネットワーク設定（エンドポイントURL or
https通信FW設定等）を確認してください。

エラーコードの例■インスタンス起動APIの実行
1）API発行する端末より以下APIコマンドを実行する~正常の場合$ ./kick_api.sh command=startVirtualMachine id=<uuid>~正常値の場合：実行結果~
id =<uuid>
SEND URL:
https://<URL:PORT>/client/api?command=startVirtualMachine&id=<uuid>&apikey=<APIkey>&signature=xTff5SUN8KglgMt678ba0tW3z%2Fo%3D<?xml version="1.0" encoding="UTF-8" standalone="yes"?><startvirtualmachineresponse cloud-stack-version="4.3.0.2"><jobid>3d9ebfa2-7e01-42bf-9c79-7d79af02210b</jobid>★JOB_IDが発行されている</startvirtualmachineresponse>2）API発行する端末より以下APIコマンドを実行する~Errorｺｰﾄﾞ401の場合$ ./kick_api.sh command=startVirtualMachine id=<uuid>~Error値の場合：実行結果~
SEND URL:
https://<URL:PORT>/client/api?command=startVirtualMachine&id=<uuid>&apikey=<APIkey>&signature=EuW23gOc4fZ3kuQlUjGdL1bcFz4%3D★APIキーが間違っている<?xml version="1.0" encoding="UTF-8" standalone="yes"?><startvirtualmachineresponse cloud-stack-version="4.3.0.2"><cserrorcode>400</cserrorcode><errorcode>401</errorcode><errortext>Unable to verify user credentials and/or request signature.</errortext></startvirtualmachineresponse>※APIでのErrorの場合JOB_IDは発行されません。必ず引数とAPI文字が合っているかご確認ください。
正しいJOBが発行されたとしても、JOBの経過は「queryAsyncJobResult」「queryExAsyncJobResult」のAPIでご確認ください。

3エラーコードの例
3）API発行する端末より以下APIコマンドを実行する~Errorｺｰﾄﾞ403の場合./kick_api.sh command=startVirtualMachin id=<uuid>★Command文字が間違っている~Error値の場合：実行結果~
SEND URL: https://<URL:PORT>/client/api?command=startVM&id=<uuid>&apikey=<APIkey>&signature=BVuAthfKlrl8nbaSQ37yvXWW%2FZY%3D<?xml version="1.0" encoding="UTF-8"?><errorresponse><errorcode>403</errorcode><errortext> Forbidden </errortext></errorresponse>4）API発行する端末より以下APIコマンドを実行する~Errorｺｰﾄﾞ500の場合./kick_api.sh command=deployPremiumVirtualMachine name=test hypervisor=VMware zoneid=<zoneid> templateid=<templateid>
serviceofferingid=<serviceofferingid> hostname=kc2-west01-Losv-000031 iptonetworklist[0].networkid=<networkid>★引数が間違っている（「jp2」とすべきところを「kc2」とタイプミス）~Error値の場合：実行結果~
SEND URL:
https://<URL:PORT>/client/api?command=deployPremiumVirtualMachine&i=<uuid>&apikey=<APIkey>&signature=Hbu4HGfr0Oskx1LaEpFJl4%3D<?xml version="1.0" encoding="UTF-8" standalone="yes"?><deploypremiumvirtualmachineresponse cloud-stack-version="4.3.0.2"><cserrorcode>400</cserrorcode><errorcode>500</errorcode><errortext>The Host you specified could not be found.</errortext></deploypremiumvirtualmachineresponse>

4エラーコードの例

5）API発行する端末より以下APIコマンドを実行する~応答タイムアウトErrorの場合./kick_api.sh command=startVirtualMachine id=<uuid>~Error値の場合：実行結果~★APIに指定しているアドレスが違う
SEND URL:
https://<URL:PORT>/client/api?command=startVirtualMachine&id=<uuid>&apikey=<APIkey>&signature=xTff5SUN8KglgMt678ba0tW3z%2Fo%3D
curl: (7) couldn't connect to host
※APIでのErrorの場合JOB_IDは発行されません。必ず引数とAPI文字が合っているかご確認ください。
正しいJOBが発行されたとしても、JOBの経過は「queryAsyncJobResult」「queryExAsyncJobResult」のAPIでご確認ください。

5

切り分けた結果KDDI問合せとなった場合の連絡先≪KDDI クラウドプラットフォームサービス(KCPS)の故障・お問い合わせ窓口≫
お問い合わせはAdmin Console(https://admin.cloud-platform.kddi.ne.jp/)ログイン直後の画面上部にある「サポート」のWEB問合せフォームよりお問合せください。
お問い合わせの際は、下記の情報をお伝え下さい。
・ご利用サービス名（=KDDI クラウドプラットフォームサービス）
・サーバ契約番号（Mで始まる9桁の番号）
・KDDI WVS回線番号（拠点側WVSご利用の場合）
KDDI WVS以外のVPNサービス拠点からのご利用の場合は、当該VPNサービスの回線番号をお伝え下さい。
回線側の故障が明確な場合は（お客さま拠点の全端末通信不能など）、早急な復旧対応のため、回線側の問合せ先にご連絡下さい。
※故障箇所がご不明の場合は、上記「KDDI クラウドプラットフォームサービス(KCPS)故障・お問合せ窓口」までご連絡ください。
下記オペレーションにおいて、1時間以上経過後も終了しない場合は窓口にご連絡をお願いします。
・スナップショットからのボリューム・テンプレート作成
・ボリュームからのテンプレート作成
・テンプレートからのインスタンス作成
・インスタンスへのボリュームアタッチ

6