単一のAdventure Worldの完全なメタデータおよび反映可能な作成パラメータをクエリします。ビルド進捗のポーリングには、Worldビルドステータスクエリエンドポイントを使用してください。
スコープ
単一のAdventure Worldの完全なメタデータおよび反映可能な作成パラメータをクエリします。呼び出し前に以下を確認してください:
-
認証:プライマリ API Key のみがサポートされています。一時的な API Key は使用できません(エラーコード
403003)。- プライマリ API Key を取得する:API Key の取得と設定。
-
前提条件:Create World によって返された
encryptedWorldIdを使用してクエリします。構築進捗のポーリングには Query World Build Status を使用してください。 -
Caller:サーバーから呼び出されます。
HTTP リクエスト
Singapore
GET https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/detail
{WorkspaceId} を実際の ワークスペースID に置き換えます。
中国(北京)
GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/detail
{WorkspaceId} を実際の ワークスペースID に置き換えます。
米国(バージニア)
GET https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-adventure/openapi/v1/worlds/detail
{WorkspaceId} を実際の ワークスペースID に置き換えます。
リクエストパラメーター | World詳細のクエリ |
Authorization API Key 認証。プライマリ API Key のみがサポートされており、 | |
クエリパラメータ | |
encryptedWorldId 現在のプライマリアカウント配下のAdventure暗号化World IDです。Worldを作成によって返されます。 |
レスポンスパラメーター | クエリ成功 |
code リターンコード。 | |
message エラーメッセージ。成功時は | |
data レスポンスデータ。失敗時は |
前提条件となるステータスと呼び出しに関する注意事項
- このエンドポイントは
generating、ready、またはfailed状態のWorldをクエリできます。準備が整う前のビルド成果物はnullとなる場合があります。 - 詳細エンドポイントは
asyncをエコーしません。これはWorldの属性ではなく、呼び出し動作の切り替えであるためです。 - 画像はURLおよび
referenceTypeとしてのみ返されます。作成リクエスト内のbase64コンテンツは返されません。 - 別のモデル、別のプライマリアカウント、または削除済みのWorldをクエリした場合、いずれも
403001が返され、リソースが存在するかどうかは開示されません。
エラーコード
モデルの呼び出しに失敗してエラーが返された場合は、HappyOyster エラーコードを参照して解決してください。
次のステップ
- Worldリストのクエリ: すべてのAdventure Worldをページネーションで取得します。
- Delete World:不要になったWorldを削除します。
- Worldが
ready状態の場合、Get Travel Credentialを実行できます。