*Nội dung này được dịch bằng AI (Beta) và có thể có lỗi. Để xem trang này bằng tiếng Anh, hãy nhấp vào đây.

Instance

Đại diện cho một ví dụ về mô hình dữ liệu.

Thuộc Tính

pathstring

Con đường tài nguyên của instance.

Định dạng: universes/{universe_id}/places/{place_id}/instances/{instance_id}.

hasChildrenboolean
Chỉ Xuất

liệu instance có bất kỳ instance con không.

engineInstanceobject

chi tiết thuộc tính của instance.

URL Cơ Sở
https://apis.roblox.com
Tài nguyên Instance
{

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

  "hasChildren": true,

  "engineInstance": {

    "Id": "string",

    "Parent": "string",

    "Name": "string",

    "Details": {

      "Folder": {}

    }

  }

}

Instance

Nhận Instances
Bản Beta

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

Nhận một instance và dữ liệu thuộc tính của nó.

Kích thước dữ liệu phản hồi tối đa được hỗ trợ là 500,000 bayt.Nếu giới hạn này bị vượt quá, Operation trả về sẽ được hoàn thành với kết quả lỗi có mã lỗi là 422 .

Phạm Vi
universe.place.instance:read
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

place_idstring
Bắt Buộc

ID nơi.

instance_idstring
Bắt Buộc

ID của instance.

Phản Hồi

Phương pháp này không đồng bộ và trả về một "Hoạt Động" cho biết trạng thái hiện tại của hoạt động. Phương pháp chứa một đường dẫn điểm cuối mà bạn có thể thăm dò để nhận về phản hồi thực tế và siêu dữ liệu hiện hành. Xem [tài liệu] (/cloud/reference/patterns#long-running-operations) về các hoạt động kéo dài để biết thêm thông tin.

Các phần dưới đây mô tả những phản hồi và siêu dữ liệu có được khi một hoạt động hoàn thành.

Phản HồiInstanceSiêu dữ liệu

Không Có

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

Cập nhật Instances
Bản Beta

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

Cập nhật dữ liệu thuộc tính của một ví dụ.

Khi cập nhật tài sản nguồn của một Script ví dụ, kích thước tài sản tối đa được hỗ trợ là 200,000 baytes sau khi mã hóa UTF-8.

Phạm Vi
universe.place.instance:write
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

place_idstring
Bắt Buộc

ID nơi.

instance_idstring
Bắt Buộc

ID của instance.

Tham Số Truy Vấn
updateMaskstring

Danh sách các trường để cập nhật. Chuỗi này được định dạng là Mặt nạ trường.

Yêu Cầu Cơ ThểInstance
Phản Hồi

Phương pháp này không đồng bộ và trả về một "Hoạt Động" cho biết trạng thái hiện tại của hoạt động. Phương pháp chứa một đường dẫn điểm cuối mà bạn có thể thăm dò để nhận về phản hồi thực tế và siêu dữ liệu hiện hành. Xem [tài liệu] (/cloud/reference/patterns#long-running-operations) về các hoạt động kéo dài để biết thêm thông tin.

Các phần dưới đây mô tả những phản hồi và siêu dữ liệu có được khi một hoạt động hoàn thành.

Phản HồiInstanceSiêu dữ liệu

Không Có

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

Danh sách trẻ của ví dụ
Bản Beta

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

Danh sách con của một ví dụ.

Kích thước dữ liệu phản hồi tối đa được hỗ trợ là 500,000 bayt.Nếu giới hạn này bị vượt quá, Operation trả về sẽ được hoàn thành với kết quả lỗi có mã lỗi là 422 .

Phạm Vi
universe.place.instance:read
Yêu CầuTham Số Đường Dẫn
universe_idstring
Bắt Buộc

ID của vũ trụ.

place_idstring
Bắt Buộc

ID nơi.

instance_idstring
Bắt Buộc

ID của instance.

Tham Số Truy Vấn
maxPageSizenumber

Số lượng tối đa của ví trẻ cần trả về.Dịch vụ có thể trả về ít hơn giá trị này.Nếu không được xác định, tối đa 200 trẻ em sẽ được trả lại.Giá trị tối đa là 200; các giá trị trên 200 sẽ bị buộc thành 200.

pageTokenstring

Một token trang, nhận được từ cuộc gọi trước ListInstanceChildrenRequest , cung cấp nó để lấy lại trang tiếp theo.

Khi paginate, tất cả các tham số khác được cung cấp cho ListInstanceChildrenRequest phải phù hợp với cuộc gọi cung cấp token trang.

Phản Hồi

Phương pháp này không đồng bộ và trả về một "Hoạt Động" cho biết trạng thái hiện tại của hoạt động. Phương pháp chứa một đường dẫn điểm cuối mà bạn có thể thăm dò để nhận về phản hồi thực tế và siêu dữ liệu hiện hành. Xem [tài liệu] (/cloud/reference/patterns#long-running-operations) về các hoạt động kéo dài để biết thêm thông tin.

Các phần dưới đây mô tả những phản hồi và siêu dữ liệu có được khi một hoạt động hoàn thành.

Phản Hồi

Trả về một danh sách các con của instance.

instancesarray<Instance>

Một danh sách các ví dụ con.

nextPageTokenstring

Một token, có thể được gửi như page_token để lấy trang tiếp theo. Nếu trường này bị bỏ qua, không có trang tiếp theo.

Siêu dữ liệu

Không Có

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}'