DescribeServiceMeshUpgradeStatus - Alibaba Cloud Service Mesh - Alibaba Cloud ドキュメントセンター

ASM インスタンスと ASM ゲートウェイのアップグレードステータスを問い合わせます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

servicemesh:DescribeServiceMeshUpgradeStatus

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ServiceMeshId	string	必須	ASM インスタンスの ID。	11fd0027-c27e-41bb-a565-75583054****
GuestClusterIds	string	任意	ASM インスタンスに追加されるデータプレーンクラスタの ID。複数の ID はカンマで区切ります。	caeac85a793c94afbbb0a4bb20320****
AllIstioGatewayFullNames	string	任意	ASM ゲートウェイの完全修飾名。複数の名前はカンマで区切ります。	istio-system:ingressgateway1,istio-system:ingressgateway2

レスポンスフィールド

フィールド	型	説明	例
	object	アップグレードステータス。
RequestId	string	リクエスト ID。	11fd0027-c27e-41bb-a565-75583054****
UpgradeDetail	object	アップグレードステータスの詳細。
FinishedGatewaysNum	integer	アップグレードされたゲートウェイの数。	1
MeshStatus	string	ASM インスタンスのステータス。有効な値： running：インスタンスは実行中です。 `upgrading`：インスタンスはアップグレード中です。 `upgrading_failed`：アップグレードに失敗しました。	running
TotalGatewaysNum	integer	ゲートウェイの総数。	2
GatewayStatusRecord	object	ASM ゲートウェイのステータスレコード。
	object	ASM ゲートウェイのステータス。
Status	string	ASM ゲートウェイのアップグレードステータス。有効な値： `upgrading`：ゲートウェイはアップグレード中です。 `pending`：アップグレードは保留中です。 `finished`：アップグレードは完了です。 `notStart`：アップグレードはまだ開始されていません。 `failed`：アップグレードに失敗しました。 `unknown`：ステータスは不明です。	upgrading
Message	string	ASM ゲートウェイに関する追加のステータス情報。	success
Version	string	ASM ゲートウェイのバージョン。	1.9.7

例

成功レスポンス

JSONJSON

{
  "RequestId": "11fd0027-c27e-41bb-a565-75583054****",
  "UpgradeDetail": {
    "FinishedGatewaysNum": 1,
    "MeshStatus": "running",
    "TotalGatewaysNum": 2,
    "GatewayStatusRecord": {
      "key": {
        "Status": "upgrading",
        "Message": "success",
        "Version": "1.9.7"
      }
    }
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	ERR404	Not found

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。