Web Apps - Get Instance Info

Tjänst:

App Service

API-versionen:

2025-05-01

Beskrivning för Hämtar alla utskalningsinstanser av en app.

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
instanceId	path	True	string
name	path	True	string	Namnet på appen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svaren

Namn	Typ	Beskrivning
200 OK	WebSiteInstanceStatus	Azure-åtgärden har slutförts.
Other Status Codes	DefaultErrorResponse	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	personifiera ditt användarkonto

Exempel

Get site instance info

Exempelförfrågan

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/instances/134987120?api-version=2025-05-01

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/GetSiteInstanceInfo.json
func ExampleWebAppsClient_GetInstanceInfo() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().GetInstanceInfo(ctx, "testrg123", "tests346", "134987120", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.WebAppsClientGetInstanceInfoResponse{
	// 	WebSiteInstanceStatus: &armappservice.WebSiteInstanceStatus{
	// 		Name: to.Ptr("134987120"),
	// 		Type: to.Ptr("Microsoft.Web/sites/instances"),
	// 		ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging/instances/134987120"),
	// 		Properties: &armappservice.WebSiteInstanceStatusProperties{
	// 			Containers: map[string]*armappservice.ContainerInfo{
	// 				"c1": &armappservice.ContainerInfo{
	// 					CurrentTimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2013-10-21T13:28:06.419Z"); return t}()),
	// 				},
	// 			},
	// 			DetectorURL: to.Ptr("testsec579"),
	// 			State: to.Ptr(armappservice.SiteRuntimeStateREADY),
	// 			StatusURL: to.Ptr("https://sampleurl"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exempelsvar

Statuskod:

200

{
  "name": "134987120",
  "type": "Microsoft.Web/sites/instances",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging/instances/134987120",
  "properties": {
    "containers": {
      "c1": {
        "currentTimeStamp": "2013-10-21T13:28:06.419Z"
      }
    },
    "detectorUrl": "testsec579",
    "state": "READY",
    "statusUrl": "https://sampleurl"
  }
}

Definitioner

Namn	Beskrivning
ContainerCpuStatistics
ContainerCpuUsage
ContainerInfo
ContainerMemoryStatistics
ContainerNetworkInterfaceStatistics
ContainerThrottlingData
createdByType	Den typ av identitet som skapade resursen.
DefaultErrorResponse	App Service-felsvar.
DefaultErrorResponseError	Felmodell.
DefaultErrorResponseErrorDetailsItem	Detaljerade fel.
SiteRuntimeState
systemData	Metadata som rör skapande och senaste ändring av resursen.
WebSiteInstanceStatus	Konkreta proxyresurstyper kan skapas genom att aliasisera den här typen med hjälp av en specifik egenskapstyp.

ContainerCpuStatistics

Objekt

Namn	Typ	Beskrivning
cpuUsage	ContainerCpuUsage
onlineCpuCount	integer (int32)
systemCpuUsage	integer (int64)
throttlingData	ContainerThrottlingData

ContainerCpuUsage

Objekt

Namn	Typ	Beskrivning
kernelModeUsage	integer (int64)
perCpuUsage	integer[] (int64)
totalUsage	integer (int64)
userModeUsage	integer (int64)

ContainerInfo

Objekt

Namn	Typ	Beskrivning
currentCpuStats	ContainerCpuStatistics
currentTimeStamp	string (date-time)
eth0	ContainerNetworkInterfaceStatistics
id	string
memoryStats	ContainerMemoryStatistics
name	string
previousCpuStats	ContainerCpuStatistics
previousTimeStamp	string (date-time)

ContainerMemoryStatistics

Objekt

Namn	Typ	Beskrivning
limit	integer (int64)
maxUsage	integer (int64)
usage	integer (int64)

ContainerNetworkInterfaceStatistics

Objekt

Namn	Typ	Beskrivning
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

Objekt

Namn	Typ	Beskrivning
periods	integer (int32)
throttledPeriods	integer (int32)
throttledTime	integer (int32)

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Beskrivning
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Objekt

App Service-felsvar.

Namn	Typ	Beskrivning
error	DefaultErrorResponseError	Felmodell.

DefaultErrorResponseError

Objekt

Felmodell.

Namn	Typ	Beskrivning
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
details	DefaultErrorResponseErrorDetailsItem[]	Detaljerade fel.
innererror	string	Mer information för att felsöka fel.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

DefaultErrorResponseErrorDetailsItem

Objekt

Detaljerade fel.

Namn	Typ	Beskrivning
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

SiteRuntimeState

Uppräkning

Värde	Beskrivning
READY
STOPPED
UNKNOWN

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Namn	Typ	Beskrivning
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

WebSiteInstanceStatus

Objekt

Konkreta proxyresurstyper kan skapas genom att aliasisera den här typen med hjälp av en specifik egenskapstyp.

Namn	Typ	Beskrivning
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Typ av resurs.
name	string	Namnet på resursen
properties.consoleUrl	string	Länka till konsolen till webbappinstansen
properties.containers	<string,  ContainerInfo>	Ordbok över <ContainerInfo>
properties.detectorUrl	string	Länk till portalen för att diagnostisera och lösa problem
properties.healthCheckUrl	string	Länka till konsolen till webbappinstansen
properties.physicalZone	string	Den fysiska zon som instansen finns i
properties.state	SiteRuntimeState
properties.statusUrl	string	Länk till GetStatusApi i Kudu
systemData	systemData	Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"