用於在 Roblox Cloud 上執行 Luau 的 HTTP API。

表示一個動態類型的值，可以是空、數字、字符串、布爾值、遞歸結構值或值列表。

父集合中的 LuauExecutionSessionTaskLogs 列表。

指定 LuauExecutionSessionTask 的 LuauExecutionSessionTaskLogs。

可作為 `pageToken` 參數發送的標記，以檢索下一頁。如果省略此字段，則沒有後續頁面。

`LuauExecutionSessionTask`（簡稱"任務"）在特定版本的地點上下文中執行給定的 Luau 腳本。

在任務中，物理模擬不會運行。伺服器和本地腳本在地點內也不會自動運行。

腳本可以訪問並更新地點的數據模型，包括調用任何模塊腳本。但是，數據模型的更改是任務的本地更改，無法持久化。

腳本還可以調用讀取和/或修改存儲在雲中的數據的引擎 API，例如 DataStores。在使用這些 API 時請謹慎。

腳本可以最大為 4 MB 且最多運行 5 分鐘。運行超過時間限制的腳本將以錯誤終止。

腳本按原樣執行，不必包裹在函數中。

腳本可以返回值（使用 Luau 的 `return` 關鍵字）。返回值序列化為 JSON，並且在任務完成後可以通過 `Get LuauExecutionSessionTask` API 獲取。返回值在 JSON 序列化後的總大小不得超過 4 MB。如果超過限制，任務將以錯誤終止。

如果腳本引發未處理的錯誤，則任務終止。錯誤信息可以通過 `GetLuauExecutionSessionTask` API 獲取。

標準輸出（由 Luau 的 `print` 函數生成）可以在任務完成後通過 `ListLuauExecutionSessionTaskLogs` 方法獲取。最多保留 450 KB 的日誌。如果日誌數量超過限制，則舊日誌將被丟棄。

有關任務的信息在任務完成後保留 24 小時。

每個地點最多允許十個未完成的任務。在第一批十個任務未完成時嘗試創建更多任務會導致 HTTP 429 響應。

此任務的二進位輸入的資源路徑。請參閱有關 `LuauExecutionSessionTaskBinaryInput` 資源的文檔以獲取使用詳情。

此任務的二進位輸出的 URI。請參閱 `enableBinaryOutput` 字段以獲取使用詳情。

如果設置為 true，允許任務在標準返回值之外輸出大型二進位對象。

如果將 `enable_binary_output` 設置為 true，則任務腳本必須返回 `LuauExecutionTaskOutput`（或等效表）而不返回其他值。

以下是實現的示例代碼：

```luau
local buf: buffer = buffer.create(10)
local result: LuauExecutionTaskOutput = {
  BinaryOutput = buf,
  ReturnValues = { "hello world", 123 }
}
return result
```

`BinaryOutput` 緩衝區的大小必須不超過 256 MiB。

如果給定，`ReturnValues` 數組將序列化為 JSON，並在任務完成後可在 `LuauExecutionSessionTask` 資源的 `output` 字段中使用，類似於未使用 `enable_binary_output` 的常規返回值。

任務完成後，可以從 `binaryOutputUri` 字段的 URI 獲取二進位輸出。`binaryOutputUri` 在任務完成後有效 15 分鐘。

Luau 執行會話任務的資源路徑。

格式：
* `universes/{universe_id}/places/{place_id}/luau-execution-session-tasks/{luau_execution_session_task_id}`
* `universes/{universe_id}/places/{place_id}/versions/{place_version_id}/luau-execution-session-tasks/{luau_execution_session_task_id}`
* `universes/{universe_id}/places/{place_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{luau_execution_session_task_id}`
* `universes/{universe_id}/places/{place_id}/versions/{place_version_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{luau_execution_session_task_id}`

作為此任務一部分運行的腳本。

例如：

```luau
local x = 3
local y = 4
return x + y
```

任務的狀態。查看狀態枚舉以了解每個可能值的信息。

可能的值：

  | 值 | 描述 |
  | --- | --- |
  | STATE_UNSPECIFIED | 未指定 |
  | QUEUED | 任務正在等待處理。 |
  | PROCESSING | 任務已被選取以進行處理。 |
  | CANCELLED | 任務已被用戶停止。 |
  | COMPLETE | 任務已完成處理。輸出字段包含輸出。 |
  | FAILED | 任務失敗。錯誤字段包含有關錯誤的詳細信息。 |

限制腳本運行的時間。

如果腳本未在指定的持續時間內完成，任務將失敗。

默認為 5 分鐘。

創建用於創建此任務的 API 密鑰的用戶。

表示可以提供給 `LuauExecutionSessionTask` 的大型二進位輸入。

每個 `LuauExecutionSessionTaskBinaryInput` 都與一個預簽名的 URL 相關聯，可用於上傳任意對象。在上傳對象後，可以在創建 `LuauExecutionSessionTask` 時傳遞 `LuauExecutionSessionTaskBinaryInput` 的路徑，以使該對象對任務可用。

在任務內，對象的內容可以在作為第一個參數傳遞給腳本的表中使用，鍵為 `BinaryInput`。以下示例演示如何檢索數據：

```
local taskInput: LuauExecutionTaskInput = ({...})[1]
local buf: buffer = taskInput.BinaryInput
```

每個 `LuauExecutionSessionTaskBinaryInput` 從創建時間起有效 15 分鐘。在此時間內，如有需要，您可以使用它為同一宇宙創建多個任務。

上傳的二進位對象的大小不得超過 100 MiB。

Luau 執行會話任務二進位輸入的資源路徑。

格式：
`universes/{universe_id}/luau-execution-session-task-binary-inputs/{luau_execution_session_task_binary_input_id}`

要上傳的二進位輸入對象的大小。

允許的最大大小為 100 MiB。

使用此 URI 上傳二進位輸入對象。

表示由 `LuauExecutionSessionTask` 生成的一段日誌消息。

保留的日誌數量有限。詳細信息請參閱 `LuauExecutionSessionTask` 資源的文檔。

日誌的保留時間與父任務保持一致。

任務執行生成的日誌消息列表。
每次從任務腳本代碼中的 Luau `print()` 函數調用都會在此處產生一個單獨的列表項，即使消息本身包含換行符。當視圖為 FLAT（默認情況下）時，會填充此字段。

Luau 執行會話任務日誌的資源路徑。

格式：
* `universes/{universe_id}/places/{place_id}/luau-execution-session-tasks/{luau_execution_session_task_id}/logs/{luau_execution_session_task_log_id}`
* `universes/{universe_id}/places/{place_id}/versions/{place_version_id}/luau-execution-session-tasks/{luau_execution_session_task_id}/logs/{luau_execution_session_task_log_id}`
* `universes/{universe_id}/places/{place_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{luau_execution_session_task_id}/logs/{luau_execution_session_task_log_id}`
* `universes/{universe_id}/places/{place_id}/versions/{place_version_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{luau_execution_session_task_id}/logs/{luau_execution_session_task_log_id}`

任務執行生成的日誌消息及其相關元數據的列表。
每次從任務腳本代碼中的 Luau `print()` 函數調用都會在此處產生一個單獨的列表項，即使消息本身包含換行符。當視圖為 STRUCTURED 時，會填充此字段。

日誌消息的 `MessageType`。

可能的值：

  | 值 | 描述 |
  | --- | --- |
  | MESSAGE_TYPE_UNSPECIFIED | 未指定 |
  | OUTPUT | 對應於引擎 API 的 `MessageOutput` 枚舉值。 |
  | INFO | 對應於引擎 API 的 `MessageInfo` 枚舉值。 |
  | WARNING | 對應於引擎 API 的 `MessageWarning` 枚舉值。 |
  | ERROR | 對應於引擎 API 的 `MessageError` 枚舉值。 |

如果執行失敗則包含錯誤詳細信息。

錯誤代碼，表示錯誤的類別。

可能的值：

  | 值 | 描述 |
  | --- | --- |
  | ERROR_CODE_UNSPECIFIED | 未指定 |
  | SCRIPT_ERROR | 任務的腳本引發了未處理的錯誤。 |
  | DEADLINE_EXCEEDED | 任務超過了最大允許的執行持續時間。 |
  | OUTPUT_SIZE_LIMIT_EXCEEDED | 任務的輸出太大。 |
  | INTERNAL_ERROR | 任務因內部系統錯誤而失敗。 |

包含有關錯誤的更多詳細信息的錯誤消息。

運行的腳本返回的值。無法 JSON 序列化的返回值（例如數據模型實例）將返回為 null。

可配置的密鑰，可允許對 Roblox 資源進行細粒度訪問。詳情請參見 https://create.roblox.com/docs/cloud/auth/api-keys。

x-api-key

表示 Roblox 用戶身份的瀏覽器 Cookie。切勿分享此內容。共享此內容將允許他人以您的身份登錄並盜取您的 Robux 和物品。我們不建議使用 Cookie 來調用端點。在可能的情況下，請使用帶有 x-api-key 標頭的 API 密鑰或 OAuth 2.0 進行身份驗證。

.ROBLOSECURITY

構建或授權應用程序以訪問 Roblox 資源。詳情請參見 https://create.roblox.com/docs/cloud/auth/oauth2-overview。

Roblox API。詳情請參見 https://create.roblox.com/docs/cloud/open-cloud。

Roblox API

創建一個新的 `LuauExecutionSessionTaskBinaryInput`。

universe_id

創建 Luau 執行會話任務二進位輸入

LuauExecutionSessionTaskBinaryInput

universe.place.luau-execution-session:write

創建任務但不等待任務完成。

要檢查任務是否已完成，請調用`GetLuauExecutionSessionTask`方法並檢查返回資源的`state`字段。

配額：
* 每個API密鑰擁有者每分鐘5次呼叫
* 每個IP地址每分鐘45次呼叫

place_id

LuauExecutionSessionTask

Creates a task but does not wait for the task to complete.

To check whether a task has
completed, call the `GetLuauExecutionSessionTask` method and inspect the
`state` field of the returned resource.

Quotas:
* 5 calls per minute per API key owner
* 45 calls per minute per IP address

version_id

Gets information about a task.

Quotas:
* 45 calls per minute per API key owner or IP address

luau_execution_session_id

task_id

The view in which to retrieve the luau execution session task.

Supports BASIC and FULL.

Defaults to BASIC.

Possible values:

  | Value | Description |
  | --- | --- |
  | VIEW_UNSPECIFIED | The luau execution session task view is not specified; the default will be used. |
  | BASIC | Excludes the `script` field. |
  | FULL | Includes all fields. |

view

universe.place.luau-execution-session:read

Lists log chunks generated by a `LuauExecutionSessionTask`.

Quotas:
* 45 calls per minute per API key owner or IP address

The maximum number of luau execution session task logs to return. The
service might return fewer than this value. If unspecified, at most 10000
luau execution session task logs are returned. The maximum value is 10000
and higher values are set to 10000.

maxPageSize

A page token, received from a previous call, to retrieve a subsequent page.

When paginating, all other parameters provided to the subsequent call must
match the call that provided the page token.

pageToken

The view in which to retrieve the luau execution session task log.

Supports FLAT and STRUCTURED.

Defaults to FLAT.

Possible values:

  | Value | Description |
  | --- | --- |
  | VIEW_UNSPECIFIED | The luau execution session task log view is not specified; the default will be used. |
  | FLAT | If this view is selected, the `messages` field will be populated (and the `structuredMessages` field will not). Each entry of the `messages` array contains only the log message, without additional medata.  This is the default. |
  | STRUCTURED | If this view is selected, the `structuredMessages` field will be populated (and the `messages` field will not). Each entry of the `structuredMessages` array contains the log message plus additional metadata (see `LogMessage` for details). |

LuauExecutionSessionTaskLog

Luau Execution

體驗

虛擬人偶

素材

範例與專案

引擎 API

開放式雲端 API

Studio

分析

平台

教學

創作者計畫

教育

課程

學習

此方法不同步且會傳回一個「Operation」，代表該操作的目前狀態。其中包含一個端點路徑，您可以輪詢以獲得實際回應和適用的中繼資料。詳情請參閱關於長期執行操作的[說明文件]({longRunningOperationsLink})。
            
以下部分描述操作完成時提供的回應和中繼資料物件。

Beta 測試終點已準備好公開使用。可能出現導致功能無法正常運作的變更，但機率不高。

這些開放式雲端文件頁面將於 2026 年 3 月 31 日移除。屆時，系統會自動將你重新導向至新版開放式雲端文件。{linkStart}瞭解詳情{linkEnd}

這些舊版開放式雲端頁面將於 2026 年 3 月 31 日移除，並重新導向至新頁面。{linkStart}瞭解詳情{linkEnd}

實驗端點已可供公開使用，但隨著 API 合約結束，可能會偶爾發生重大變更。

此終點可在體驗內透過 {httpServiceLinkStart}HttpService{httpServiceLinkEnd} 使用 API 金鑰呼叫。

建立資源時可設定此欄位，但可能無法在後續請求中修改。

建立資源時可設定這些欄位，但可能無法在後續請求中修改。

此欄位可在請求中提供，但永遠不會包含在回應中。

舊版本驗證方法。可用時，請務必使用 API 金鑰或 OAuth 2.0。

每個 API 金鑰：每個 IP 位址每 {periodInSeconds} 秒 {maxInPeriod} 個請求

無需驗證即可呼叫。通常會大幅降低速率限制。可用時，請務必使用 API 金鑰或 OAuth 2.0。

對於每個群組，只需提供架構中下列任一欄位，其餘可省略。

你隨時可以重新加入。{linkStart}歡迎提供回饋。{linkEnd}

你正在檢視舊版文件。{linkStart}歡迎提供回饋。{linkEnd}

你可以隨時選擇退出，並重新導向回舊版參考頁面。{linkStart}歡迎提供任何回饋。{linkEnd}

你正在檢視新版文件。{linkStart}歡迎提供回饋。{linkEnd}

此欄位可在回應中設定，但將在請求中被忽略。

注意：在高流量期間，速率限制可能會降低。部分端點有額外的速率限制。[深入瞭解速率限制]({link})。

使用者或群組所有 API 金鑰每日 {limit} 次要求數

使用者或群組所有 API 金鑰每小時 {limit} 次要求數

使用者或群組所有 API 金鑰每分鐘 {limit} 次要求數

使用者或群組所有 API 金鑰每秒 {limit} 次要求數

每位 API 金鑰擁有者每分鐘 {limit} 次要求數

每位應用程式使用者每日 {limit} 次要求數

每位應用程式使用者每小時 {limit} 次要求數

每位應用程式使用者每分鐘 {limit} 次要求數

每位應用程式使用者每秒 {limit} 次要求數

每位 API 金鑰擁有者每秒 {limit} 次要求數

範圍控制憑證的權限。憑證只能存取你選取的範圍所支援的端點。

穩定終點已準備好投入正式環境，在其生命週期中幾乎不會發生破壞性變更。

此目標可讓你將金鑰存取權限制為所選的{requiredParts}

此目標可讓你將金鑰存取權限制為所選的{requiredParts}和{optionalParts}

目標類型是用來限制憑證對於資源的權限。即使你的帳戶擁有其他資源的權限，也只能對所選資源執行操作。某些操作範圍不包含特定目標部分。在這種情況下，所有相關資源皆可操作。

對於使用者擁有的 API 金鑰，無需選擇宇宙的頂層部分。在這種情況下，你的 API 金鑰將可存取你所擁有的使用者體驗內容，以及你具備正確群組權限的所有群組體驗內容。

「立即試試」功能尚未支援需要 API 金鑰或 OAuth 2.0 驗證的端點

為了安全起見，Cookie 驗證在高風險操作中已停用。

關鍵風險端點極為敏感，為了安全起見，已停用「立即試試」功能

注意：此程式碼範例中不包含驗證標頭資訊。你可能需要為此指令新增驗證標頭，才能正常運作。

這是一個高風險端點，用以修改或刪除關鍵資料。測試時請格外小心。

此 API 端點已被歸類為高風險，且可能會影響即時資料或使用者帳號。

對於高風險 API 的驗證請求，可能會造成無法撤銷的變更。請在繼續之前仔細檢查請求參數。

這是一個低風險端點，用以擷取資料。測試這個端點通常是安全的。

這是一個中等風險端點，用以修改資料。請謹慎地使用非關鍵帳戶測試，因為變更可能是永久性的。

為了確保帳號安全，切勿從其他來源貼上文字，或將此頁面的資訊傳送給其他人。

你即將使用實際帳號憑證來測試已發布的 API 端點。

除非你了解即將進行的 API 呼叫可能涉及的後果，方可繼續操作。在測試之前，請仔細閱讀 API 文件。

API 呼叫將透過你已驗證的工作階段進行

這些皆為實際 API 呼叫，可能會影響你的帳號或資料

部分操作可能會修改或刪除資料

此終點已被這些建議的替代終點取代：

需要以下範圍才能呼叫此端點。若要了解更多
關於產生正確金鑰的資訊，請參閱[管理 API 金鑰]({apiKeyReferenceDocLink})。

若要了解更多關於產生金鑰的資訊，請參閱[管理 API 金鑰]({apiKeyReferenceDocLink})。

根據相對基本網址的路徑，可使用下列終點。

此字串的格式為 [FieldMask](/cloud/reference/types#fieldmask)。

JSON 值可為「null」、「boolean」、「string」、「number」、「array」或「object」。

若想使用此端點，您的 OAuth 2.0 應用程式需要以下範圍。有關如何註冊 OAuth 2.0 應用程式的更多資訊，請查看[應用程式註冊和審查]({oauth2ReferenceDocLink})。

若要了解更多關於如何註冊 OAuth 2.0 應用程式的資訊，請參閱[App 註冊與審核]({oauth2ReferenceDocLink})。

以下物件描述被接受或退回的負載。若要獲得更多關於物件使用時機的資訊，請查看個別終點。

需要以下範圍才能呼叫此端點。

資源路徑

此字串的格式為 [Timestamp](/cloud/reference/types#timestamp)。

若想使用此端點，您的 OAuth 2.0 應用程式需要以下範圍。有關如何註冊 OAuth 2.0 應用程式的更多資訊，請查看 [應用程式註冊和審查]（{oauth2ReferenceDocLink}）。

不推薦

你正在檢視新版 Open Cloud 參考資料。

你已選擇退出新版 Open Cloud 參考資料。

建立、更新並管理你的廣告活動。

這可以查看有關您資產的資訊。

這可以上傳和更新 Roblox 的資產。

這項操作可讓你查看主體（包括群組和體驗）的素材權限，以及帳號可存取的素材。

這會允許授予素材權限給您的帳號可存取的任何對象（包含群組和體驗）及素材。

這項操作可讓你代為檢視虛擬人偶自動設定工作的狀態和結果。

這項操作可讓你代為建立和管理虛擬人偶自動設定工作。

授予更新使用者所擁有之徽章的能力。

這會允許查看您商品的相關資訊。

這麼做可對已同步的商品進行變更。

此操作可讓你檢視商務聯絡對象的資訊。

這會允許對您的商務商家連結進行編輯。

這能讓您檢視您創作者商店商品的相關資訊。

這能讓您修改您創作者商店商品的相關資訊。

這項操作可以讓你查看創作者商店儲存項目的相關資訊。

這項操作可讓你修改創作者商店儲存項目的相關資訊。

授予代為建立資料存儲的存取權。

授予代為刪除資料存儲的權限。

授予讀取資料存儲清單的存取權。

授予為資料存儲拍攝快照的存取權。

授予在資料存儲中建立條目的存取權。

授予標記指定條目以進行刪除的存取權。

授予可列出資料存儲項目的存取權。

授予在資料存儲中讀取指定條目的存取權。

授予更新項目值、屬性和使用者的存取權。

授予可刪除資料存儲條目修訂版的存取權。

授予可列出資料存儲條目修訂版的存取權。

授予可讀取資料存儲條目修訂版的存取權。

授予檢視授權使用者開發者產品設定詳細資訊的權限。

授予編輯授權使用者開發者產品的權限。

這會允許查看您宇宙環境的相關資訊。

授予檢視授權使用者遊戲通行證設定詳細資訊的權限。

授予編輯授權使用者遊戲通行證的權限。

授予檢視帳號社群論壇資訊的權限。

授予管理帳號社群論壇資訊的權限。

這會允許查看您社群的相關資訊。

這能讓您管理自己帳號的社群加入申請和低階社群成員的角色更新。

允許你修改個體的屬性資料（目前僅支援指令碼）。

這可以查看有關您道具欄的資訊。

授予管理使用者資產的存取權。

授予管理您徽章和花費 Robux 的權限。

授予更新授權使用者徽章的權限。

授予管理您開發者產品的權限。

授予存取權限，以讀取你已開啟通知的體驗相關資訊。

授予存取權限，代你開啟或關閉體驗通知。

授予讀取與寫入您在地化表格的權限。

授予管理您擁有之所有體驗的團隊協作權限。

授予管理您的體驗及部分體驗相關資訊（例如：在地化資訊）的權限。

授予讀取您體驗之在地化資訊的權限。

授予修改您體驗在地化偏好的權限。

授予管理您使用者帳號的權限。

授予修改使用者在地化偏好的權限。

允許你檢視關聯地點的 Luau 執行任務狀態、紀錄和結果。

允許你為關聯地點建立新的 Luau 執行任務。

授予非同步清除宇宙中所有資料結構的存取權。

授予建立新佇列項目的存取權。

授予從佇列前端捨棄讀取項目的存取權。

授予從佇列前端讀取項目的權限。

授予讀取記憶存儲項目的存取權。

授予建立、更新和刪除地圖項目的存取權。

給予代替使用者發布訊息的能力。

這能讓您的體驗向使用者傳送通知。

（棄用）授予在已排序資料存儲中讀取條目清單的存取權。

（棄用）授予在已排序資料存儲中建立新條目的存取權。

授予從已排序資料存儲中列出條目的存取權。

授予在已排序資料存儲中建立條目的存取權。

此將允許列出與您的體驗相關的機密資料。

此將允許建立並更新與您的體驗相關的機密資料。

此權限可讓你提交評估工作，並檢視工作結果。

授予讀取您訂閱產品相關資訊的權限。

這項操作可讓你代為讀取縮圖資訊。

授予發佈新版本體驗到 Roblox 的權限。

授予編輯授權使用者體驗的權限。

讓您檢視體驗中的使用者限制。

讓您在體驗中編輯使用者限制。

這項操作將允許檢視傳送至你帳號的通知。

授予讀取權限，查看授權使用者的高級會員與驗證狀態。

此舉可以讓你查看授權使用者的社群帳號。

這將授予讀取您個人檔案資訊的權限。

Luau Execution

Places