*이 콘텐츠는 AI(베타)를 사용해 번역되었으며, 오류가 있을 수 있습니다. 이 페이지를 영어로 보려면 여기를 클릭하세요.

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

인스턴스 가져오기
베타

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.

응답

비동기적 방식으로, 현재 작업 상태를 나타내는 '작업'을 반환합니다. 여기에는 투표를 진행하여 실제 응답과 적용 가능한 메타데이터를 얻을 수 있는 엔드포인트 경로가 포함됩니다. 자세한 정보는 장기 작업에 관한 설명서에서 확인하세요.

아래 섹션은 작업 완료 시 제공되는 응답 및 메타데이터 개체에 대한 설명입니다.

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

인스턴스 업데이트
베타

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

비동기적 방식으로, 현재 작업 상태를 나타내는 '작업'을 반환합니다. 여기에는 투표를 진행하여 실제 응답과 적용 가능한 메타데이터를 얻을 수 있는 엔드포인트 경로가 포함됩니다. 자세한 정보는 장기 작업에 관한 설명서에서 확인하세요.

아래 섹션은 작업 완료 시 제공되는 응답 및 메타데이터 개체에 대한 설명입니다.

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

인스턴스 자식 목록
베타

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에 제공된 페이지 토큰을 제공한 호출과 일치해야 합니다.

응답

비동기적 방식으로, 현재 작업 상태를 나타내는 '작업'을 반환합니다. 여기에는 투표를 진행하여 실제 응답과 적용 가능한 메타데이터를 얻을 수 있는 엔드포인트 경로가 포함됩니다. 자세한 정보는 장기 작업에 관한 설명서에서 확인하세요.

아래 섹션은 작업 완료 시 제공되는 응답 및 메타데이터 개체에 대한 설명입니다.

응답

인스턴스의 자식 목록을 반환합니다.

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