次の方法で共有

アプリケーションの種類の情報リストを名前で取得する

  • [アーティクル]

指定した名前と完全に一致する Service Fabric クラスター内のアプリケーションの種類の一覧を取得します。

Service Fabric クラスターでプロビジョニングされた、またはプロビジョニング中のアプリケーションの種類に関する情報を返します。 これらは、名前がパラメーターとして指定されたものと完全に一致し、指定されたクエリ パラメーターに適合するアプリケーションの種類の結果です。 アプリケーションの種類の名前に一致するアプリケーションの種類のすべてのバージョンが返されます。各バージョンは 1 つのアプリケーションの種類として返されます。 応答には、名前、バージョン、状態、およびアプリケーションの種類に関するその他の詳細が含まれています。 これがページング クエリです。つまり、すべてのアプリケーションの種類が 1 ページに収まらない場合、1 ページの結果と次のページを取得するために使用できる継続トークンが返されます。 たとえば、10 個のアプリケーションの種類があって、1 ページに最初の 3 つのアプリケーションの種類しか収まらない場合、または max results が 3 に設定されている場合は、3 が返されます。 残りの結果にアクセスするには、返された継続トークンを次のクエリで使用して、後続のページを取得します。 後続のページが存在しない場合は、空の継続トークンが返されます。

Request

Method 要求 URI
GET /ApplicationTypes/{applicationTypeName}?api-version=6.0&ApplicationTypeVersion={ApplicationTypeVersion}&ExcludeApplicationParameters={ExcludeApplicationParameters}&ContinuationToken={ContinuationToken}&MaxResults={MaxResults}&timeout={timeout}

パラメーター

名前 Type 必須 場所
applicationTypeName string はい パス
api-version string はい クエリ
ApplicationTypeVersion string いいえ クエリ
ExcludeApplicationParameters boolean いいえ クエリ
ContinuationToken string いいえ クエリ
MaxResults integer (int64) いいえ クエリ
timeout integer (int64) いいえ クエリ

applicationTypeName

型: 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 バージョンに従います。

ApplicationTypeVersion

型: string
必須: いいえ

アプリケーションの種類のバージョン。

ExcludeApplicationParameters

型: boolean
必須: いいえ
既定値:

アプリケーションのパラメーターを結果から除外するかどうかを指定するフラグ。

ContinuationToken

型: string
必須: いいえ

継続トークンのパラメーターは、次の結果セットを取得するために使用されます。 システムからの結果が 1 つの応答に収まらない場合は、空以外の値を持つ継続トークンが API の応答に含まれます。 この値が次の API 呼び出しに渡されると、API が次の結果セットを返します。 それ以上の結果がない場合は、継続トークンに値が含まれません。 このパラメーターの値を URL にエンコードすることはできません。

MaxResults

型: integer (int64)
必須: いいえ
既定値:
InclusiveMinimum: 0

ページング クエリの一部として返される結果の最大数。 このパラメーターは、返される結果の数に上限を定義します。 返された結果が、構成で定義したメッセージの最大サイズの制限に収まらない場合は、指定した最大結果数よりも少なくなる場合があります。 このパラメーターがゼロまたは指定されていない場合、ページング クエリには、応答メッセージに収まるできるだけ多くの結果が含まれます。

timeout

型: integer (int64)
必須: いいえ
既定値:
InclusiveMaximum: 4294967295
InclusiveMinimum: 1

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求した操作が完了するまでクライアントが待機できる期間を指定します。 このパラメーターの既定値は 60 秒です。

応答

HTTP 状態コード 説明 応答スキーマ
200 (OK) クラスター内のアプリケーションの種類の一覧。
 PagedApplicationTypeInfoList
その他のすべての状態コード 詳細なエラー応答。
 FabricError