이름으로 애플리케이션 유형 정보 목록 가져오기

아티클
07/19/2023

지정된 이름과 정확히 일치하는 Microsoft Azure Service Fabric 클러스터에서 애플리케이션 종류의 목록을 가져옵니다.

Microsoft Azure Service Fabric 클러스터에 프로비전된 또는 프로비전되는 프로세스에 있는 애플리케이션 유형에 대한 정보를 반환합니다. 이러한 결과는 이름이 매개 변수로 지정된 것과 정확히 일치하며 주어진 쿼리 매개 변수를 준수해야 하는 애플리케이션 유형에서 나온 값입니다. 하나의 애플리케이션 형식으로 반환된 각 버전과 함께 애플리케이션 형식 이름과 일치하는 애플리케이션 형식의 모든 버전입니다. 응답에는 이름, 버전, 상태 및 애플리케이션에 관한 기타 세부 정보가 포함됩니다. 이것은 페이징된 쿼리로 애플리케이션 유형 모두가 한 페이지에 맞지 않는 경우, 결과 한 페이지가 연속 토큰으로 반환되어 다음 페이지를 가져오는 데 사용될 수 있습니다. 예를 들어 10개의 애플리케이션 형식이 있지만 페이지는 처음 3개 애플리케이션 형식에만 맞거나, 최대 결과가 3으로 설정된다면, 3이 반환됩니다. 결과의 나머지 부분에 액세스하려면 다음 쿼리에 반환된 연속 토큰을 사용하여 후속 페이지를 검색합니다. 후속 페이지가 없다면 공백인 연속 토큰이 반환됩니다.

요청

메서드	요청 URI
GET	`/ApplicationTypes/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}`

매개 변수

속성	형식	필수	위치
`applicationTypeName`	문자열	예	경로
`api-version`	문자열	예	쿼리
`ApplicationTypeVersion`	문자열	예	쿼리
`ExcludeApplicationParameters`	boolean	예	쿼리
`ContinuationToken`	문자열	예	쿼리
`MaxResults`	정수(int64)	아니요	쿼리
`timeout`	정수(int64)	아니요	쿼리

`applicationTypeName`

형식: 문자열
필수: 예

애플리케이션 유형의 이름입니다.

`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 버전에 따라 다릅니다.

`ApplicationTypeVersion`

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

애플리케이션 유형의 버전입니다.

`ExcludeApplicationParameters`

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

애플리케이션 매개 변수가 결과에서 제외될지 여부를 지정하는 플래그입니다.

`ContinuationToken`

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

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

`MaxResults`

형식: 정수(int64)
필수: 아니요
기본: 0
InclusiveMinimum: 0

페이징된 쿼리의 일부로 반환될 결과의 최대 수입니다. 이 매개 변수는 반환되는 결과 수에 상한값을 정의합니다. 반환되는 결과는 구성에 정의된 최대 메시지 크기 제한에 따라 메시지에 맞지 않는 경우 지정된 최대의 결과보다 작을 수 있습니다. 이 매개 변수가 0이거나 지정되지 않은 경우 페이징된 쿼리는 반환 메시지에 맞는 가능한 많은 결과를 포함합니다.

`timeout`

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

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

응답

HTTP 상태 코드	설명	응답 스키마
200(확인)	클러스터의 애플리케이션 유형 목록입니다.	PagedApplicationTypeInfoList
다른 모든 상태 코드	자세한 오류 응답입니다.	FabricError

Share via