클라우드

Instance

Represents a data model instance.

특성

pathstring

The resource path of the instance.

Format: universes/{universe_id}/places/{place_id}/instances/{instance_id}.

hasChildrenboolean
출력 전용

whether the instance has any children instance.

engineInstanceobject

the property details of the instance.

기본 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

Get Instance
베타

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

Gets an instance and its property data.

The maximum supported response data size is 500,000 bytes. If this limit is exceeded, the returned Operation will be completed with an error result that has an error code of 422.

범위
universe.place.instance:read
요청경로 매개 변수
universe_idstring
필수

The universe ID.

place_idstring
필수

The place ID.

instance_idstring
필수

The instance ID.

응답

This method is asynchronous and returns an Operation, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the documentation on long-running operations for more information.

The following sections describe the response and metadata objects that are provided when an operation completes.

응답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

Update Instance
베타

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

Updates an instance's property data.

When updating a Script instance's source property, the maximum supported property size is 200,000 bytes after UTF-8 encoding.

범위
universe.place.instance:write
요청경로 매개 변수
universe_idstring
필수

The universe ID.

place_idstring
필수

The place ID.

instance_idstring
필수

The instance ID.

쿼리 매개 변수
updateMaskstring

The list of fields to update. 이 문자열은 FieldMask 형식으로 지정됩니다.

요청 본문Instance
응답

This method is asynchronous and returns an Operation, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the documentation on long-running operations for more information.

The following sections describe the response and metadata objects that are provided when an operation completes.

응답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

List Instance Children
베타

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

Lists an instance's children.

The maximum supported response data size is 500,000 bytes. If this limit is exceeded, the returned Operation will be completed with an error result that has an error code of 422.

범위
universe.place.instance:read
요청경로 매개 변수
universe_idstring
필수

The universe ID.

place_idstring
필수

The place ID.

instance_idstring
필수

The instance ID.

쿼리 매개 변수
maxPageSizenumber

The maximum number of child instance to return. The service may return fewer than this value. If unspecified, at most 200 children will be returned. The maximum value is 200; values above 200 will be coerced to 200.

pageTokenstring

A page token, received from a previous ListInstanceChildrenRequest call. Provide this to retrieve the subsequent page.

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

응답

This method is asynchronous and returns an Operation, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the documentation on long-running operations for more information.

The following sections describe the response and metadata objects that are provided when an operation completes.

응답

Returns a list of the instance's children.

instancesarray<Instance>

A list of children instances.

nextPageTokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

메타데이터

없음

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