ヘルス ダッシュボードへの APS 情報の統合 のとおり、Autodesk Platform Services API の稼働状況は、製品サービスと同様に Autodesk Health Dashboard(ヘルス ダッシュボード、https://health.autodesk.com/)に表示されます。ただし、障害発生時には、具体的な原因の調査と内容を示す概要文の作成などで人的作業が発生してしまい、ヘルス ダッシュボードへの状態反映に遅延が出てしまう場合があります。
コンピューティング サービスの 1 つである Design Automation API を利用するアプリの場合、ヘルス ダッシュボード ページでの目視ではなく、GET health/:engine エンドポイントを呼び出すことで、プログラム的にエンジン別の稼働状態(ヘルス ステータス)を取得することが出来ます。
2024年10月現在、GET health/:engine エンドポイントのドキュメント更新が一部追い付いていないようですが、次のエンジン別のステータスに加えて、すべてのエンジン ステータスも一度に取得することも出来るようになっています。
- AutoCAD:
https://developer.api.autodesk.com/da/us-east/v3/health/autocad - Revit:
https://developer.api.autodesk.com/da/us-east/v3/health/revit - Inventor:
https://developer.api.autodesk.com/da/us-east/v3/health/inventor - 3ds Max:
https://developer.api.autodesk.com/da/us-east/v3/health/3dsmax - すべて:
https://developer.api.autodesk.com/da/us-east/v3/health/api
いずれの場合も、リクエストの Authorization ヘッダーによるアクセス トークンの指定は不要です。このため、上記リンクをクリックするだけで、ヘルス ステータスを含む JSON レスポンスを得ることが出来るはずです。例えば、を呼び出した場合のレスポンスは次のようになります。
{"engines":{"AutoCAD":{"Status":"Fully Operational"},"Revit":{"Status":"Fully Operational"},"Inventor":{"Status":"Fully Operational"},"3dsMax":{"Status":"Fully Operational"},"Test":{"Status":"Fully Operational"}}}
ステータスに含まれる値と意味は下記のとおりです。
Fully Operational |
エンジンは稼働中です。 |
Synthetic Check Failed |
オートデスクが利用する AWS 側で問題が発生・サービスが停止したり、フロントエンドのコードに何か問題が発生したりすると、すべてのエンジンに「Synthetic Check Failed」が返されます。1つのエンジンのみに「Synthetic Check Failed」が返される場合、同エンジンがSynthetic Check WorkItemに失敗したり、Synthetic Check WorkItemの処理が間に合わなかったり(トラフィックが多すぎる)する状態を示します。 |
Health status does not exist in S3 |
まだ実装されていない未稼働のエンジンがある場合に返されます。 |
障害発生時には、APS のエンドポイント呼び出しで、Rate Limit(呼び出し数制限)を示す 429 レスポンスが返される場合があります。この際には、即座に再リクエストするのではなく。"retry-after " レスポンス ヘッダーに従って、示された x 秒後に再試行するような実装をお願いします。詳細は、Rate Limit ドキュメントをご確認ください。
By Toshiaki Isezaki
コメント
コメントフィードを購読すればディスカッションを追いかけることができます。