Web Apps - List Instance Identifiers

サービス:

App Service

API バージョン:

2024-11-01

アプリのすべてのスケールアウト インスタンスを取得するための説明。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances?api-version=2024-11-01

URI パラメーター

名前	/	必須	型	説明
name	path	True	string	アプリの名前。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	リソースが属するリソース グループの名前。
subscriptionId	path	True	string	Azure のサブスクリプション ID。 これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)。
api-version	query	True	string	API バージョン

応答

名前	型	説明
200 OK	WebAppInstanceStatusCollection	[OK]
Other Status Codes	DefaultErrorResponse	App Service エラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

定義

名前	説明
ContainerCpuStatistics
ContainerCpuUsage
ContainerInfo
ContainerMemoryStatistics
ContainerNetworkInterfaceStatistics
ContainerThrottlingData
DefaultErrorResponse	App Service エラー応答。
Details
Error	エラー モデル。
SiteRuntimeState
WebAppInstanceStatusCollection	アプリ インスタンスのコレクション。
WebSiteInstanceStatus

ContainerCpuStatistics

Object

名前	型	説明
cpuUsage	ContainerCpuUsage
onlineCpuCount	integer (int32)
systemCpuUsage	integer (int64)
throttlingData	ContainerThrottlingData

ContainerCpuUsage

Object

名前	型	説明
kernelModeUsage	integer (int64)
perCpuUsage	integer[] (int64)
totalUsage	integer (int64)
userModeUsage	integer (int64)

ContainerInfo

Object

名前	型	説明
currentCpuStats	ContainerCpuStatistics
currentTimeStamp	string (date-time)
eth0	ContainerNetworkInterfaceStatistics
id	string
memoryStats	ContainerMemoryStatistics
name	string
previousCpuStats	ContainerCpuStatistics
previousTimeStamp	string (date-time)

ContainerMemoryStatistics

Object

名前	型	説明
limit	integer (int64)
maxUsage	integer (int64)
usage	integer (int64)

ContainerNetworkInterfaceStatistics

Object

名前	型	説明
rxBytes	integer (int64)
rxDropped	integer (int64)
rxErrors	integer (int64)
rxPackets	integer (int64)
txBytes	integer (int64)
txDropped	integer (int64)
txErrors	integer (int64)
txPackets	integer (int64)

ContainerThrottlingData

Object

名前	型	説明
periods	integer (int32)
throttledPeriods	integer (int32)
throttledTime	integer (int32)

DefaultErrorResponse

Object

App Service エラー応答。

名前	型	説明
error	Error	エラー モデル。

Details

Object

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

Error

Object

エラー モデル。

名前	型	説明
code	string	プログラムによってエラーを識別するための標準化された文字列。
details	Details[]	詳細なエラー。
innererror	string	デバッグ エラーの詳細。
message	string	エラーの詳細な説明とデバッグ情報。
target	string	エラーの詳細な説明とデバッグ情報。

SiteRuntimeState

列挙

値	説明
READY
STOPPED
UNKNOWN

WebAppInstanceStatusCollection

Object

アプリ インスタンスのコレクション。

名前	型	説明
nextLink	string	リソースの次のページへのリンク。
value	WebSiteInstanceStatus[]	リソースのコレクション。

WebSiteInstanceStatus

Object

名前	型	説明
id	string	リソース ID。
kind	string	リソースの種類。
name	string	リソース名。
properties.consoleUrl	string	コンソールから Web アプリ インスタンスへのリンク
properties.containers	<string,  ContainerInfo>
properties.detectorUrl	string	診断と解決ポータルへのリンク
properties.healthCheckUrl	string	コンソールから Web アプリ インスタンスへのリンク
properties.physicalZone	string	インスタンスが存在する物理ゾーン
properties.state	SiteRuntimeState
properties.statusUrl	string	Kudu の GetStatusApi へのリンク
type	string	リソースの種類。