GetUpgradeStatus - Container Service for Kubernetes - Alibaba Cloud ドキュメントセンター

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに CS(2015-12-15) - DescribeTaskInfo への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

cs:GetUpgradeStatus

get

*Cluster

acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}

なし

リクエスト構文

GET /api/v2/clusters/{ClusterId}/upgrade/status HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
ClusterId	string	必須	クラスター ID。	c106f377e16f34eb1808d6b9362c9****

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	クラスターの更新の進捗に関する詳細。
error_message	string	更新中に返されるエラーメッセージ。	subject to actual return
precheck_report_id	string	事前チェックレポートの ID。	be4c8eb72de94d459ea7ace7c811d119
status	string	更新のステータス。有効な値は次のとおりです： `success`：更新に成功しました。 `fail`：更新に失敗しました。 `pause`：更新は一時停止中です。 `running`：更新は進行中です。	running
upgrade_step	string	更新の現在のフェーズ。有効な値は次のとおりです： `not_start`：更新は開始されていません。 `prechecking`：事前チェックが進行中です。 `upgrading`：クラスターを更新中です。 `pause`：更新は一時停止中です。 `success`：更新に成功しました。	prechecking
upgrade_task	object	更新タスクの詳細。
status	string	更新タスクのステータス。有効な値は次のとおりです： `running`：更新タスクは実行中です。 `Success`：更新タスクの実行に成功しました。 `Failed`：更新タスクの実行に失敗しました。	running
message	string	更新タスクの説明。	subject to actual return

例

成功レスポンス

JSONJSON

{
  "error_message": "subject to actual return",
  "precheck_report_id": "be4c8eb72de94d459ea7ace7c811d119",
  "status": "running",
  "upgrade_step": "prechecking",
  "upgrade_task": {
    "status": "running",
    "message": "subject to actual return"
  }
}

エラーコード

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

変更履歴

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