サービス情報の一覧を取得する
アプリケーション ID で指定されたアプリケーションに属するすべてのサービスに関する情報を取得します。
アプリケーション ID で指定されたアプリケーションに属するすべてのサービスに関する情報を返します。
Request
Method | 要求 URI |
---|---|
GET | /Applications/{applicationId}/$/GetServices?ServiceTypeName={ServiceTypeName}&api-version=6.0&ContinuationToken={ContinuationToken}&timeout={timeout} |
パラメーター
名前 | Type | 必須 | 場所 |
---|---|---|---|
applicationId |
string | はい | パス |
ServiceTypeName |
string | いいえ | クエリ |
api-version |
string | はい | クエリ |
ContinuationToken |
string | いいえ | クエリ |
timeout |
integer (int64) | いいえ | クエリ |
applicationId
型: string
必須: はい
アプリケーションの ID。 これは、通常は、'fabric:' URI スキームのないアプリケーションの完全な名前です。
バージョン 6.0 以降では、階層名は "~" 文字で区切られます。
たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、6.0 以降ではアプリケーション ID は "myapp~app1" になり、前のバージョンでは "myapp/app1" になります。
ServiceTypeName
型: string
必須: いいえ
クエリを実行するサービスをフィルター処理するために使用されるサービスの種類名。
api-version
型: string
必須: はい
既定値:
API のバージョン。 このパラメーターは必須であり、その値は '6.0' である必要があります。
Service Fabric REST API のバージョンは、API が導入または変更されたランタイム バージョンに基づいています。 Service Fabric ランタイムでは、複数のバージョンの API がサポートされています。 これは、サポートされている API の最新バージョンです。 より低い API バージョンが渡された場合、返される応答は、この仕様に記載されている応答とは異なる場合があります。
さらに、ランタイムは、現在のバージョンのランタイムまで、サポートされている最新バージョンより高いバージョンを受け入れます。 したがって、最新の API バージョンが 6.0 ですが、ランタイムが 6.1 の場合、クライアントの記述を容易にするために、ランタイムはその API のバージョン 6.1 を受け入れます。 ただし、API の動作は、文書化されている 6.0 バージョンに従います。
ContinuationToken
型: string
必須: いいえ
継続トークンのパラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合は、空以外の値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API が次の結果セットを返します。 それ以上の結果がない場合は、継続トークンに値が含まれません。 このパラメーターの値を URL にエンコードすることはできません。
timeout
型: integer (int64)
必須: いいえ
既定値:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1
操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。
応答
HTTP 状態コード | 説明 | 応答スキーマ |
---|---|---|
200 (OK) | 指定したアプリケーションのクラスター内のサービスの一覧。 |
PagedServiceInfoList |
その他すべての状態コード | 詳細なエラー応答。 |
FabricError |