Share via


하위 이름 정보 목록 가져오기

지정된 이름 아래에 있는 모든 Service Fabric 이름을 열거합니다.

지정된 이름 아래에 있는 모든 Service Fabric 이름을 열거합니다. 하위 이름이 페이지에 맞지 않으면 결과의 한 페이지와 다음 페이지를 가져오는 데 사용할 수 있는 연속 토큰이 반환됩니다. 존재하지 않는 이름을 쿼리하면 실패합니다.

요청

메서드 요청 URI
GET /Names/{nameId}/$/GetSubNames?api-version=6.0&Recursive={Recursive}&ContinuationToken={ContinuationToken}&timeout={timeout}

매개 변수

속성 형식 필수 위치
nameId 문자열 경로
api-version 문자열 쿼리
Recursive boolean 쿼리
ContinuationToken 문자열 쿼리
timeout 정수(int64) 아니요 쿼리

nameId

형식: 문자열
필수: 예

‘fabric:’ URI 체계가 없는 Service Fabric 이름입니다.


api-version

형식: 문자열
필수: 예
기본: 6.0

API 버전입니다. 이 매개 변수는 필수이며 해당 값은 '6.0'이어야 합니다.

Service Fabric REST API 버전은 API가 도입되었거나 변경된 런타임 버전을 기반으로 합니다. Service Fabric 런타임은 둘 이상의 API 버전을 지원합니다. 지원되는 최신 버전의 API입니다. 더 낮은 API 버전이 전달되면 반환된 응답이 이 사양에 설명된 응답과 다를 수 있습니다.

또한 런타임은 현재 버전의 런타임까지 지원되는 최신 버전보다 높은 모든 버전을 허용합니다. 따라서 최신 API 버전이 6.0이지만 런타임이 6.1인 경우 클라이언트를 더 쉽게 작성하기 위해 런타임은 해당 API에 대해 버전 6.1을 수락합니다. 그러나 API의 동작은 문서화된 6.0 버전에 따라 다릅니다.


Recursive

형식: 부울
필수: 아니요
기본: false

수행된 검색이 재귀적이어야 하도록 지정할 수 있습니다.


ContinuationToken

형식: 문자열
필수: 아니요

연속 토큰 매개 변수는 다음 결과 집합을 얻는 데 사용됩니다. 공백 값이 아닌 연속 토큰은 시스템의 결과가 단일 응답에 맞지 않는 경우 API의 응답에 포함됩니다. 이 값이 다음 API 호출에 전달되면 API는 다음 결과 집합을 반환합니다. 결과가 더 이상 없으면 연속 토큰에 값이 포함되지 않습니다. 이 매개 변수의 값은 URL 인코딩이 되지 말아야 합니다.


timeout

형식: 정수(int64)
필수: 아니요
기본: 60
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

작업을 수행하기 위한 서버 제한 시간(초)입니다. 이 시간 제한은 요청된 작업이 완료될 때까지 클라이언트가 기다릴 시간을 지정합니다. 이 매개 변수의 기본값은 60초입니다.

응답

HTTP 상태 코드 설명 응답 스키마
200(확인) Service Fabric 이름의 페이징된 목록입니다.
PagedSubNameInfoList
다른 모든 상태 코드 자세한 오류 응답입니다.
FabricError

예제

하위 이름 가져오기

이 예제에서는 지정된 Service Fabric 이름의 모든 하위 이름에 대한 정보를 가져오는 방법을 보여 줍니다.

요청

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0

200 응답

본문
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/mynames"
  ]
}

하위 이름을 재귀적으로 검색

이 예제에서는 지정된 Service Fabric 이름의 모든 자식 하위 이름에 대한 정보를 재귀적으로 가져오는 방법을 보여 줍니다.

요청

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True

200 응답

본문
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps",
    "fabric:/samples/data",
    "fabric:/samples/CalculatorApp",
    "fabric:/samples/CalculatorApp/CalculatorService",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-1",
    "fabric:/samples/CalculatorApp/CalculatorService/Name-2",
    "fabric:/samples/mynames/name-1"
  ]
}

연속 토큰을 사용하는 페이지

이 예제에서는 ContinuationToken 매개 변수를 사용하여 지정된 Service Fabric 이름 아래의 하위 이름에 대한 정보를 페이지스하는 방법을 보여 줍니다. 이 매개 변수의 값은 이전 쿼리에서 제공되며, 이 경우 위에 표시된 예제입니다. 응답에는 나머지 두 개의 결과와 빈 ContinuationToken이 포함됩니다. 빈 ContinuationToken은 추가 결과를 사용할 수 없음을 나타냅니다.

요청

GET http://localhost:19080/Names/samples/$/GetSubNames?api-version=6.0&Recursive=True&ContinuationToken=fabric:/samples/apps/PersistentQueueApp$131439231986491349

200 응답

본문
{
  "ContinuationToken": "",
  "IsConsistent": true,
  "SubNames": [
    "fabric:/samples/apps/VolatileQueueApp",
    "fabric:/samples/apps/NotepadApp"
  ]
}