배포된 애플리케이션 정보 목록 가져오기

아티클
07/19/2023

Microsoft Azure Service Fabric 노드에서 배포된 애플리케이션의 목록을 가져옵니다.

Microsoft Azure Service Fabric 노드에서 배포된 애플리케이션의 목록을 가져옵니다. 결과는 ID별에 대해 명시적으로 쿼리되지 않는 한 배포된 시스템 애플리케이션에 대한 정보를 포함하지 않습니다. 결과는 활성, 활성화 중 및 상태 다운로드 중인 배포된 애플리케이션을 포함합니다. 이 쿼리에서는 노드 이름이 클러스터의 노드에 해당해야 합니다. 제공된 노드 이름이 클러스터의 활성 Service Fabric 노드를 가리키지 않으면 쿼리가 실패합니다.

요청

메서드	요청 URI
GET	`/Nodes/{nodeName}/$/GetApplications?api-version=6.1&timeout={timeout}&IncludeHealthState={IncludeHealthState}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}`

매개 변수

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

`nodeName`

형식: 문자열
필수: 예

노드의 이름입니다.

`api-version`

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

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

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

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

`timeout`

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

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

`IncludeHealthState`

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

엔터티의 상태를 포함합니다. 이 매개 변수가 false이거나 지정되지 않은 경우 반환된 상태는 "Unknown"입니다. true로 설정된 경우 쿼리는 결과가 병합되기 전에 노드 및 상태 시스템 서비스에 병렬로 들어갑니다. 결과적으로 쿼리는 비용이 더 들며 더 긴 시간이 걸릴 수 있습니다.

`ContinuationToken`

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

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

`MaxResults`

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

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

응답

HTTP 상태 코드	설명	응답 스키마
200(확인)	작업이 성공하면 200개 상태 코드와 배포된 애플리케이션 정보 목록이 반환됩니다.	PagedDeployedApplicationInfoList
다른 모든 상태 코드	자세한 오류 응답입니다.	FabricError

예제

최대 결과 제한

이 예제에서는 특정 노드에 배포된 애플리케이션에 대한 정보를 얻을 때 쿼리에서 반환되는 애플리케이션 수를 지정하는 방법을 보여 줍니다. 페이지의 결과 수는 MaxResult 매개 변수를 사용하여 최대 2개로 제한됩니다. 이 예제에서는 상태 상태가 요청되지 않으므로 반환된 상태 상태는 알 수 없음이 됩니다.

요청

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&MaxResults=2

200 응답

본문

{
  "ContinuationToken": "fabric:/samples/PQueueApp1",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Unknown"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Unknown"
    }
  ]
}

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

이 예제에서는 특정 노드에 배포된 애플리케이션에 대한 정보를 얻을 때 사용할 수 있는 페이징 기능을 보여 줍니다. 이 예제에서는 ContinuationToken 매개 변수를 사용합니다. 이 매개 변수의 값은 이전 쿼리에서 제공됩니다. 이 경우 위에 표시된 예제입니다. 응답에는 나머지 결과와 빈 ContinuationToken이 포함됩니다. 빈 ContinuationToken은 추가 결과를 사용할 수 없음을 나타냅니다.

요청

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&ContinuationToken=fabric:/samples/PQueueApp1

200 응답

본문

{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Unknown"
    }
  ]
}

결과에 상태 포함

이 예제에서는 특정 노드에 배포된 애플리케이션에 대한 정보를 얻을 때 배포된 각 애플리케이션의 상태를 포함하는 방법을 보여 줍니다.

요청

GET http://localhost:19080/Nodes/_Node_0/$/GetApplications?api-version=6.1&IncludeHealthState=True

200 응답

본문

{
  "ContinuationToken": "",
  "Items": [
    {
      "Id": "samples~CalculatorApp",
      "Name": "fabric:/samples/CalculatorApp",
      "TypeName": "CalculatorApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~PQueueApp1",
      "Name": "fabric:/samples/PQueueApp1",
      "TypeName": "PersistentQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp",
      "HealthState": "Ok"
    },
    {
      "Id": "samples~VQueueApp1",
      "Name": "fabric:/samples/VQueueApp1",
      "TypeName": "VolatileQueueApp",
      "TypeVersion": "1.0.0",
      "Status": "Active",
      "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work",
      "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log",
      "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp",
      "HealthState": "Ok"
    }
  ]
}

Share via

배포된 애플리케이션 정보 목록 가져오기

요청

매개 변수

`nodeName`

`api-version`

`timeout`

`IncludeHealthState`

`ContinuationToken`

`MaxResults`

응답

예제

최대 결과 제한

요청

200 응답

본문

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

요청

200 응답

본문

결과에 상태 포함

요청

200 응답

본문

추가 리소스