*此内容使用人工智能（Beta）翻译，可能包含错误。若要查看英文页面，请点按 此处。

Instance

代表数据模型实例。

属性

pathstring

实例的资源路径。

格式：universes/{universe_id}/places/{place_id}/instances/{instance_id}.

hasChildrenboolean
仅输出

实例是否有任何子实例.

engineInstanceobject

实例的属性详情.

基本网址
https://apis.roblox.com
Instance 资源
{

  "path": "universes/123/places/123/instances/0123456789abcdef0123456789abcdef",

  "hasChildren": true,

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}

Instance

获取实例
Beta

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}

获取实例和其属性数据。

最大支持的响应数据规模为 500,000 字节。如果此限制超出，返回的 Operation 将用具有错误代码 422 的错误结果完成。

范围
universe.place.instance:read
请求路径参数
universe_idstring
必填

宇宙ID。.

place_idstring
必填

地点ID。.

instance_idstring
必填

实例 ID。.

答复

此方法是异步的，会返回一个Operation对象，该对象表示操作的当前状态。它包含一个端点路径，您可以轮询该路径以获取实际响应和相关的元数据。有关长时间运行操作的更多信息，请参阅文档。

以下部分描述了操作完成时提供的响应和元数据对象。

答复Instance元数据

无

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}' \

  -H 'x-api-key: {your-api-key}'

Instance

更新实例
Beta

PATCH /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}

更新实例的属性数据。

当更新Script实例的源属性时，最大允许属性大小是在 UTF-8 编码后的 200,000 字节。

范围
universe.place.instance:write
请求路径参数
universe_idstring
必填

宇宙ID。.

place_idstring
必填

地点ID。.

instance_idstring
必填

实例 ID。.

查询参数
updateMaskstring

要更新的字段列表。. 此字符串格式为 FieldMask。

请求正文Instance
答复

此方法是异步的，会返回一个Operation对象，该对象表示操作的当前状态。它包含一个端点路径，您可以轮询该路径以获取实际响应和相关的元数据。有关长时间运行操作的更多信息，请参阅文档。

以下部分描述了操作完成时提供的响应和元数据对象。

答复Instance元数据

无

PATCH /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}?updateMask={string}' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}'

Instance

列出实例子女
Beta

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren

列出实例的子集。

最大支持的响应数据规模为 500,000 字节。如果此限制超出，返回的 Operation 将用具有错误代码 422 的错误结果完成。

范围
universe.place.instance:read
请求路径参数
universe_idstring
必填

宇宙ID。.

place_idstring
必填

地点ID。.

instance_idstring
必填

实例 ID。.

查询参数
maxPageSizenumber

要返回的最大子实例数。服务可能返回小于此值。如果未指定，最多 200 个子程序将返回。最大值为 200；超过 200 的值将被强制为 200。.

pageTokenstring

来自以前的 ListInstanceChildrenRequest 调用的页面代币。提供这个以检索后续页面。

当页面分页时，所有其他参数提供给 ListInstanceChildrenRequest 必须匹配提供页面代币的调用。.

答复

此方法是异步的，会返回一个Operation对象，该对象表示操作的当前状态。它包含一个端点路径，您可以轮询该路径以获取实际响应和相关的元数据。有关长时间运行操作的更多信息，请参阅文档。

以下部分描述了操作完成时提供的响应和元数据对象。

答复

返回实例的子列表。

instancesarray<Instance>

一个列表子实例。.

nextPageTokenstring

一个代币，可以发送为 page_token 来检索下一页。如果该字段被忽略，就没有后续页面。.

元数据

无

GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren?maxPageSize=100&pageToken={string}' \

  -H 'x-api-key: {your-api-key}'