Cloud Services - Get Instance View

リファレンス

サービス:: Compute

API バージョン:: 2024-11-04

クラウドサービスの状態を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/instanceView?api-version=2024-11-04

URI パラメーター

名前	/	必須	型	説明
cloudServiceName	path	True	string	クラウドサービスの名前。
resourceGroupName	path	True	string	リソースグループの名前。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。サブスクリプション ID は、すべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	クライアント API のバージョン。

応答

名前	型	説明
200 OK	CloudServiceInstanceView	わかりました
Other Status Codes	CloudError	エラー

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

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

例

Get Cloud Service Instance View with Multiple Roles

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/instanceView?api-version=2024-11-04

応答のサンプル

状態コード:: 200

{
  "roleInstance": {
    "statusesSummary": [
      {
        "code": "ProvisioningState/succeeded",
        "count": 4
      },
      {
        "code": "PowerState/started",
        "count": 4
      },
      {
        "code": "RoleState/RoleStateStarted",
        "count": 4
      }
    ]
  },
  "sdkVersion": "2.9.6496.3",
  "privateIds": [
    "3491bc0c-1f6c-444f-b1d0-ec0751a74e3e"
  ],
  "statuses": [
    {
      "code": "ProvisioningState/succeeded",
      "level": "Info",
      "displayStatus": "Provisioning succeeded",
      "time": "2021-01-12T16:50:07.0953535+05:30"
    },
    {
      "code": "PowerState/started",
      "level": "Info",
      "displayStatus": "Started",
      "time": "2021-01-12T16:50:07.0953535+05:30"
    },
    {
      "code": "CurrentUpgradeDomain/-1",
      "level": "Info",
      "displayStatus": "Current Upgrade Domain of cloud service is -1."
    },
    {
      "code": "MaxUpgradeDomain/1",
      "level": "Info",
      "displayStatus": "Max Upgrade Domain of cloud service is 1."
    }
  ]
}

定義

名前	説明
ApiError	API エラー。
ApiErrorBase	API エラーベース。
CloudError	コンピューティングサービスからのエラー応答。
CloudServiceInstanceView	CloudService 全体の InstanceView
InnerError	内部エラーの詳細。
InstanceViewStatusesSummary	インスタンスビューの状態。
ResourceInstanceViewStatus	インスタンスビューの状態。
StatusCodeCount	クラウドサービスインスタンスビューの状態コードと数
StatusLevelTypes	レベルコード。

ApiError

API エラー。

名前	型	説明
code	string	エラーコード。
details	ApiErrorBase[]	Api エラーの詳細
innererror	InnerError	Api 内部エラー
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

ApiErrorBase

API エラーベース。

名前	型	説明
code	string	エラーコード。
message	string	エラーメッセージ。
target	string	特定のエラーのターゲット。

CloudError

コンピューティングサービスからのエラー応答。

名前	型	説明
error	ApiError	API エラー。

CloudServiceInstanceView

CloudService 全体の InstanceView

名前	型	説明
privateIds	string[]	クラウドサービスに対して内部的に生成された一意の識別子の一覧を指定します。注: Azure Diagnostics 拡張機能を使用している場合、このプロパティは詳細を照会するために "DeploymentId" として使用できます。
roleInstance	InstanceViewStatusesSummary	インスタンスビューの状態。
sdkVersion	string	クラウドサービスのパッケージの生成に使用された SDK のバージョン。
statuses	ResourceInstanceViewStatus[]	インスタンスビューの状態。

InnerError

内部エラーの詳細。

名前	型	説明
errordetail	string	内部エラーメッセージまたは例外ダンプ。
exceptiontype	string	例外の種類。

InstanceViewStatusesSummary

インスタンスビューの状態。

名前	型	説明
statusesSummary	StatusCodeCount[]	概要。

ResourceInstanceViewStatus