この 1 年間、APS 全体における可視性とコントロールの向上に継続的に取り組んできました。デベロッパーハブからトークン使用量、従量課金(後払い)レポート、そして最近ではチーム・ハブ・アプリケーション各レベルでの API 使用量レポートに至るまで、お客様が組織全体で APS がどのように利用されているかをより的確に把握出来るようにしてきました。
今回、次なる要素を追加します。事前の APS 割り当て量(クォータ)通知です。これは、チームが API 割り当て量の上限に近づいた、あるいは到達した際に管理者へアラートを送り、アプリに影響が及ぶ前に対処出来るようにするものです。
これまでは、お客様が割り当て量の問題に気づくのは、アプリが動作しなくなってからというケースが多くありました。開発者にはエラーが見える一方で、ハブ管理者やチーム管理者は、サービスがすでに影響を受けるまで、その根本原因をほとんど把握出来ませんでした。APS の割り当て量通知は、適切な人に適切なタイミングで事前の可視性を提供することによって、この問題を解決するために設計されています。
通知の種類
有料の APS API を対象に、2 種類の通知を導入しました。:
-
割り当て量の上限間近(残量低下)— 過去の使用パターンに基づいて、チームが AP Iの割り当て量に到達すると予測された際に送信されます。アプリに影響が及ぶ前に対処出来るよう、早期に警告するものです。
- 割り当て量の上限到達(残量なし)— 特定の API についてチームが割り当て量に到達し、アプリに影響が及ぶ可能性がある際に送信されます。
API 割り当て量の仕組み
API 割り当て量はチームレベルで管理され、有料の APS API ごとに個別に追跡されます。
特定の API に対するチームの割り当て量は、サブスクリプション、Autodesk Flex、その他のエンタイトルメントに由来するユニットを含み得る共有キャパシティ プールから引き当てられます。通知は、チーム全体における各 API の残り割り当て量の合計に基づいてトリガーされます。
チームの階層構造は以下のとおりです。:
チーム → ハブ → アプリ
1 つのチームは最大 5 つのデベロッパーハブを持つことが出来ます。
通知の仕組み
適切な担当者に確実に情報が届くよう、通知は Autodesk Account ポータルおよび APS 開発者ポータルの両方を通じて配信されます。
チーム管理者:割り当て量の上限間近に関するアラートの設定、監視対象とする API の選択、通知の受信者の管理のみを行えます。メールは、割り当て量に到達すると見込まれる日の 5 日前または 10 日前に、Autodesk Account ポータル経由で送信されます。
ハブ管理者およびアプリ所有者:割り当て量の上限間近・上限到達の両方のシナリオについて、APS 開発者ポータル内で直接通知を受け取ります。ハブ管理者は、ポータルの設定で有効化または無効化することが出来ます。通知は、API が割り当て量の上限に近づいた際、または到達した際に、バナーおよびメールを通じて送信されます。
重要な免責事項:
- 割り当て量の上限間近の通知は、過去の消費傾向に基づく予測的なフォーキャストを用いて、チームが割り当て量に到達する時期を推定します。すべての予測はあくまで見込みであり、最新の使用量データと併せてご活用ください。
- メールは、各ポータルにつき 24 時間ごとに最大 1 通までです。Autodesk Account ポータルと APS 開発者ポータルの両方でアラートを設定している場合は、それぞれから 1 通ずつ届くことになります。
FAQ - よくある質問
APS の「割り当て量(クォータ)」とは?
割り当て量(クォータ)とは、特定の APS API について、使い切るまでに利用可能な使用量のことです。
すべての APS API には、それぞれ独自の割り当て量があります。たとえば、Model Derivative API の割り当て量は、Automation API の割り当て量とは別物です。ある API で割り当て量が十分に残っていても、別の API では残量が少なくなっている、ということがあり得ます。APS の通知は、アカウント全体ではなく、特定の API に紐づいています。
残量低下の通知が来たのに、まだ Flex トークンが残っています。このメールは間違いですか?
メールは間違っていませんが、そう感じてしまう理由も理解できます。実際に何が起きているのかを説明します。
いずれか 1 つの API の割り当て量は、Flex トークンの残高と同じ数値ではありません。APS は、その API に使用量をもたらすすべての要素(Flex トークン、無料利用枠、お持ちの他のオートデスク製品サブスクリプションに含まれる割り当て量など)を合算して割り当て量を算出します。これらはそれぞれ、その API 固有の単位(処理時間、API 呼び出し回数、MB など)に換算され、合計されます。この合算された数値が、その API の割り当て量であり、通知はこれを基準としています。
そのため、Flex トークンが残っていても、特定の API の割り当て量が少なくなっていることはあり得ます。特に、その API が最も使用量の多い API であったり、トークンからその API 固有の単位への換算レートが高い場合に起こりやすくなります。
割り当て量はどこで確認できますか?
現時点では、APS は基礎となる各残高(Flexト ークンの合計、無料利用枠の残量など)を表示しています。API 単位で合算した割り当て量の数値を、単一の項目としてはまだ表示していません。これは現在、改善に向けて積極的に取り組んでいる点です。それが提供されるまでは、特定の API の残量が少なくなっていることを知る主要なシグナルは通知です。
それまでの間、ご自身の状況をより詳しく把握したい場合は、Flex トークンの残高、無料利用枠の割り当て、その他チームが持つ APS 関連の権限(エンタイトルメント)を確認できます。通知内容と照らし合わせて解釈する際にサポートが必要であれば、担当のアカウントチームにお問い合わせください。
まだ使い切っていないのに、なぜ通知が来るのですか?
APS の通知は予測型です。クォータがゼロになるまで待ってからお知らせするのではありません。その時点ではすでに手遅れで、アプリに影響が出てしまっている可能性があるためです。
代わりに APS は、過去の使用傾向、現在の消費ペース、残りの容量を確認し、いつ使い切る可能性があるかを予測します。その予測日が十分に近づく、チームの管理者が設定するしきい値に基づいて通知を送信します。これにより、実際に API が使えなくなる前に、計画を立てたり、容量を追加したり、使用量を調整したりする時間が確保できます。
代表的な設定は、API 利用残高が枯渇すると予測される 10 日前にチームへ通知する、というものです。この設定であれば、APS がその API の残り猶予を「10 日以下」と予測した時点でメールが届きます。
通知のタイミングは誰が決めるのですか?
通知のタイミングは、チーム管理者とハブ管理者が制御します。詳細は上記をご覧ください。
通知が多すぎる、または少なすぎると感じる場合は、チーム管理者およびハブ管理者にご相談ください。ただし、通知は有効にしておくことを強くお勧めします。現時点では、特定の API が枯渇に向かっていることを示す最も明確なシグナルだからです。
割り当て量と Flex トークンはどのような関係ですか?
Flex トークンは、任意の APS API に適用できる柔軟な通貨です。各 API には、トークンとその API の単位との間の換算レートがそれぞれ設定されています。たとえば:
- ある API では、1 Flex トークンで数時間の処理時間が得られるかもしれません。
- 別の API では、1 Flex トークンで数百〜数千回のAPI呼び出しが得られるかもしれません。
Flex トークンは共有プールであるため、ある API で大量に使用すると、チームが利用する他のすべての API で使える分が減ります。したがって、ある API で使用量の多いワークフローを実行すると、たとえ別の API をそれほど直接使っていなくても、その API の残り猶予を縮めてしまうことがあります。
特定の API の割り当て量は、Flex トークン(その API の単位に換算したもの)に、同じ API に対する無料利用枠やその他の権限を加えたものです。
通知が来たら何をすべきですか?
- メールに記載されたAPIを確認する。 通知はアカウント全体ではなく、その特定の API に関するものです。
- 対応を計画する。 通常、数日から 2 週間弱の猶予があります。
- 容量を追加するか、使用量を調整する。 選択肢としては通常、Flex トークンの追加購入、該当するサブスクリプションでの従量課金(後払い)の有効化、または影響を受ける API の使用量削減などがあります。
- チーム管理者に共有する。 購入権限をご自身がお持ちでない場合は、チーム管理者が権限を持っています。管理者が対応できるよう、通知を共有してください。
通知をオフにできますか?
はい ── チーム管理者およびハブ管理者がオフにできます。ただし、お勧めはしません。API 単位で合算したクォータが現時点ではポータル上に単一の項目として表示されていないため、通知は、特定の API が枯渇に向かっていることを示す現時点で最も明確な警告だからです。オフにすると、API が使えなくなって初めて状況に気づくことになります。
ここで何が変わろうとしているのですか?
現在の仕組みでは、お客様自身が複数の残高を頭の中で合算する必要があることは認識しており、そのフィードバックも受け止めています。API 単位で合算した割り当て量を一箇所で確認できるようにすることは、現在積極的に取り組んでいる課題です。準備が整い次第、この記事を更新します。