Web Apps - Get Instance Info
Description for Gets all scale-out instances of an app.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}?api-version=2025-03-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
instance
|
path | True |
string |
|
|
name
|
path | True |
string |
Name of the app. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$ |
Name of the resource group to which the resource belongs. |
|
subscription
|
path | True |
string |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
|
api-version
|
query | True |
string |
API Version |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
App Service error response. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Examples
Get site instance info
Sample request
GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/instances/134987120?api-version=2025-03-01
Sample response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging/instances/134987120",
"name": "134987120",
"type": "Microsoft.Web/sites/instances",
"properties": {
"state": "READY",
"statusUrl": "https://sampleurl",
"detectorUrl": "testsec579",
"containers": {
"c1": {
"currentTimeStamp": "2013-10-21T13:28:06.419Z"
}
}
}
}Definitions
| Name | Description |
|---|---|
|
Container |
|
|
Container |
|
|
Container |
|
|
Container |
|
|
Container |
|
|
Container |
|
|
Default |
App Service error response. |
| Details | |
| Error |
Error model. |
|
Site |
|
|
Web |
ContainerCpuStatistics
| Name | Type | Description |
|---|---|---|
| cpuUsage | ||
| onlineCpuCount |
integer (int32) |
|
| systemCpuUsage |
integer (int64) |
|
| throttlingData |
ContainerCpuUsage
| Name | Type | Description |
|---|---|---|
| kernelModeUsage |
integer (int64) |
|
| perCpuUsage |
integer[] (int64) |
|
| totalUsage |
integer (int64) |
|
| userModeUsage |
integer (int64) |
ContainerInfo
| Name | Type | Description |
|---|---|---|
| currentCpuStats | ||
| currentTimeStamp |
string (date-time) |
|
| eth0 | ||
| id |
string |
|
| memoryStats | ||
| name |
string |
|
| previousCpuStats | ||
| previousTimeStamp |
string (date-time) |
ContainerMemoryStatistics
| Name | Type | Description |
|---|---|---|
| limit |
integer (int64) |
|
| maxUsage |
integer (int64) |
|
| usage |
integer (int64) |
ContainerNetworkInterfaceStatistics
| Name | Type | Description |
|---|---|---|
| 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
| Name | Type | Description |
|---|---|---|
| periods |
integer (int32) |
|
| throttledPeriods |
integer (int32) |
|
| throttledTime |
integer (int32) |
DefaultErrorResponse
App Service error response.
| Name | Type | Description |
|---|---|---|
| error |
Error model. |
Details
| Name | Type | Description |
|---|---|---|
| code |
string |
Standardized string to programmatically identify the error. |
| message |
string |
Detailed error description and debugging information. |
| target |
string |
Detailed error description and debugging information. |
Error
Error model.
| Name | Type | Description |
|---|---|---|
| code |
string |
Standardized string to programmatically identify the error. |
| details |
Details[] |
Detailed errors. |
| innererror |
string |
More information to debug error. |
| message |
string |
Detailed error description and debugging information. |
| target |
string |
Detailed error description and debugging information. |
SiteRuntimeState
| Value | Description |
|---|---|
| READY | |
| STOPPED | |
| UNKNOWN |
WebSiteInstanceStatus
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id. |
| kind |
string |
Kind of resource. |
| name |
string |
Resource Name. |
| properties.consoleUrl |
string |
Link to the console to web app instance |
| properties.containers |
<string,
Container |
|
| properties.detectorUrl |
string |
Link to the Diagnose and Solve Portal |
| properties.healthCheckUrl |
string |
Link to the console to web app instance |
| properties.physicalZone |
string |
The physical zone that the instance is in |
| properties.state | ||
| properties.statusUrl |
string |
Link to the GetStatusApi in Kudu |
| type |
string |
Resource type. |