*เนื้อหานี้แปลโดยใช้ AI (เวอร์ชัน Beta) และอาจมีข้อผิดพลาด หากต้องการดูหน้านี้เป็นภาษาอังกฤษ ให้คลิกที่นี่

Instance

แทนที่ตัวแบบข้อมูลรูปแบบหนึ่ง

คุณลักษณะ

pathstring

เส้นทางทรัพยากรของตัวอย่าง

รูปแบบ: universes/{universe_id}/places/{place_id}/instances/{instance_id}.

hasChildrenboolean
เอาต์พุตเท่านั้น

ว่าตัวอย่างมีเด็กตัวอย่างใดหรือไม่.

engineInstanceobject

รายละเอียดคุณสมบัติของตัวอย่าง.

URL หลัก
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
จำเป็นต้องมี

รหัสสถานที่.

instance_idstring
จำเป็นต้องมี

ID ของตัวอย่าง.

การตอบกลับ

วิธีนี้ไม่ได้ทำพร้อมกันและส่งคืน Operation ซึ่งแสดงสถานะปัจจุบันของการดำเนินการและมีเส้นทาง Endpoint ที่คุณใช้สำรวจความคิดเห็นได้ เพื่อเช็คการตอบสนองจริงและข้อมูลเมตาที่เกี่ยวข้อง หากต้องการข้อมูลเพิ่มเติม โปรดดูเอกสารเกี่ยวกับการดำเนินการที่ใช้เวลานาน

ส่วนต่อไปนี้จะอธิบายการตอบสนองและวัตถุข้อมูลเมตาที่จะได้รับเมื่อดำเนินการเสร็จสิ้น

การตอบกลับ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 คุณสมบัติสูงสุดที่สนับสนุนคือ 200,000 ไบต์หลังจากการเข้ารหัส UTF-8

ขอบเขต
universe.place.instance:write
คำขอพารามิเตอร์เส้นทาง
universe_idstring
จำเป็นต้องมี

ID ของจักรวาล.

place_idstring
จำเป็นต้องมี

รหัสสถานที่.

instance_idstring
จำเป็นต้องมี

ID ของตัวอย่าง.

พารามิเตอร์คิวรี
updateMaskstring

รายการฟิลด์ที่จะอัปเดต. สตริงนี้มีรูปแบบ FieldMask

เนื้อหาคำขอInstance
การตอบกลับ

วิธีนี้ไม่ได้ทำพร้อมกันและส่งคืน Operation ซึ่งแสดงสถานะปัจจุบันของการดำเนินการและมีเส้นทาง Endpoint ที่คุณใช้สำรวจความคิดเห็นได้ เพื่อเช็คการตอบสนองจริงและข้อมูลเมตาที่เกี่ยวข้อง หากต้องการข้อมูลเพิ่มเติม โปรดดูเอกสารเกี่ยวกับการดำเนินการที่ใช้เวลานาน

ส่วนต่อไปนี้จะอธิบายการตอบสนองและวัตถุข้อมูลเมตาที่จะได้รับเมื่อดำเนินการเสร็จสิ้น

การตอบกลับ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
จำเป็นต้องมี

รหัสสถานที่.

instance_idstring
จำเป็นต้องมี

ID ของตัวอย่าง.

พารามิเตอร์คิวรี
maxPageSizenumber

จํานวนส่วนลูกสูงสุดที่จะส่งคืนบริการอาจส่งคืนน้อยกว่าค่านี้หากไม่ระบุ จะมีเด็กสูงสุด 200 คนที่จะถูกส่งคืนค่าสูงสุดคือ 200; ค่าสูงกว่า 200 จะถูกบังคับให้เป็น 200.

pageTokenstring

โทเค็นหน้าที่ได้รับจากการโทรก่อนหน้านี้ ListInstanceChildrenRequest ให้สิ่งนี้เพื่อดึงหน้าต่อไป

เมื่อจัดหน้า พารามิเตอร์อื่น ๆ ทั้งหมดที่ให้กับ ListInstanceChildrenRequest จะต้องตรงกับคำร้องที่ให้โทเค็นหน้า.

การตอบกลับ

วิธีนี้ไม่ได้ทำพร้อมกันและส่งคืน Operation ซึ่งแสดงสถานะปัจจุบันของการดำเนินการและมีเส้นทาง Endpoint ที่คุณใช้สำรวจความคิดเห็นได้ เพื่อเช็คการตอบสนองจริงและข้อมูลเมตาที่เกี่ยวข้อง หากต้องการข้อมูลเพิ่มเติม โปรดดูเอกสารเกี่ยวกับการดำเนินการที่ใช้เวลานาน

ส่วนต่อไปนี้จะอธิบายการตอบสนองและวัตถุข้อมูลเมตาที่จะได้รับเมื่อดำเนินการเสร็จสิ้น

การตอบกลับ

คืนรายการลูกของตัวอย่าง

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