DescribeChangeOrder API 概要 - SAE - Alibaba Cloud - Serverless App Engine

DescribeChangeOrder を呼び出して、変更オーダーに関する情報を取得します。

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sae:DescribeChangeOrder

get

*All Resource

*

なし

リクエスト構文

GET /pop/v1/sam/changeorder/DescribeChangeOrder HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ChangeOrderId	string	必須	変更オーダー ID。ListChangeOrders インターフェイスを呼び出すことで取得できます。	76fa5c0-9ebb-4bb4-b383-1f885447****

レスポンスフィールド

フィールド	型	説明	例
	object	返されたデータ。
RequestId	string	リクエスト ID。	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	リクエストに対して返されたメッセージ。	success
TraceId	string	リクエストのトレース ID。この ID はトラブルシューティングに使用されます。	0a98a02315955564772843261e****
Data	object	変更オーダーの詳細。
Status	integer	変更オーダーのステータス。有効な値： 0：準備中 1：進行中 2：成功 3：失敗 6：終了 8：手動確認待ち 9：自動確認待ち 10：システムエラーによる失敗 11：承認待ち 12：承認済み、実行待ち	2
SubStatus	integer	リリースオーダーのサブステータス。このパラメーターは、リリース中に例外が発生したかどうかを示します。有効な値： 0：正常。 1：異常。例えば、バッチリリースが失敗した場合、手動でロールバックを実行する必要があり、リリースオーダーは「進行中」の状態のままになります。	0
ApprovalId	string	操作の承認 ID。	67de0b39-a9d4-4c09-a170-cf438208****
ErrorMessage	string	エラーメッセージ。	success
BatchWaitTime	integer	自動リリースにおけるバッチ間の待機時間 (分)。	0
CreateTime	string	変更オーダーが作成された時刻。	2020-12-17 21:06:45
BatchCount	integer	バッチ数。	1
CoTypeCode	string	変更タイプコード。有効な値： CoBindSlb：SLB インスタンスをバインドします。 CoUnbindSlb：SLB インスタンスのバインドを解除します。 CoCreateApp：アプリケーションを作成します。 CoDeleteApp：アプリケーションを削除します。 CoDeploy：アプリケーションをデプロイします。 CoRestartApplication：アプリケーションを再起動します。 CoRollback：アプリケーションをロールバックします。 CoScaleIn：アプリケーションをスケールインします。 CoScaleOut：アプリケーションをスケールアウトします。 CoStart：アプリケーションを開始します。 CoStop：アプリケーションを停止します。 CoRescaleApplicationVertically：インスタンス仕様を変更します。 CoDeployHistroy：履歴バージョンにロールバックします。 CoBindNas：NAS ファイルシステムをバインドします。 CoUnbindNas：NAS ファイルシステムのバインドを解除します。 CoBatchStartApplication：アプリケーションをバッチで開始します。 CoBatchStopApplication：アプリケーションをバッチで停止します。 CoRestartInstances：インスタンスを再起動します。 CoDeleteInstances：インスタンスを削除します。 CoScaleInAppWithInstances：インスタンスを指定してアプリケーションをスケールインします。	CoRestartInstances
SupportRollback	boolean	ロールバックがサポートされているかどうかを示します。有効な値： true：ロールバックはサポートされています。 false：ロールバックはサポートされていません。	false
ChangeOrderId	string	変更オーダー ID。	765fa5c0-9ebb-4bb4-b383-1f885447**
AppName	string	アプリケーション名。	app-test
BatchType	string	バッチのリリースモード。有効な値： auto：自動リリース。 manual：手動リリース。	auto
Description	string	変更オーダーの説明。	description
CoType	string	変更タイプ。このパラメーターは `CoTypeCode` の説明です。	Batch Restart Instances
Auto	boolean	バッチで変更を自動的にリリースするかどうかを示します。有効な値： true：変更は自動的にリリースされます。 false：変更は自動的にリリースされません。	true
CurrentPipelineId	string	現在のバッチの ID。	0e4acf82-c9b1-4c1e-ac28-55776338****
Pipelines	array<object>	バッチ情報。
	object	バッチに関する情報。
Status	integer	バッチのステータス。有効な値： 0：準備中 1：進行中 2：成功 3：失敗 6：終了 8：手動確認待ち 9：自動確認待ち 10：システムエラーによる失敗 11：承認待ち 12：承認済み、実行待ち	2
StartTime	integer	バッチの開始時刻。	1562831689704
UpdateTime	integer	バッチが最後に更新された時刻。	1562847178007
BatchType	integer	バッチタイプ。	0
ParallelCount	integer	バッチ内の並列タスク数。	0
PipelineName	string	バッチ名。	Batch 1 Change
PipelineId	string	バッチ ID。	0e4acf82-c9b1-4c1e-ac28-55776338****
AppId	string	アプリケーション ID。	bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****
ApplicationUpdateStrategy	string	アプリケーションの更新ストラテジー。
ApplicationEnableGreyTagRoute	boolean	グレイタグルーティングが有効になっているかどうかを示します。
ErrorCode	string	エラーコード。リクエストが成功した場合、このパラメーターは返されません。リクエストが失敗した場合、このパラメーターが返されます。詳細については、このトピックのエラーコードセクションをご参照ください。
Code	string	HTTP ステータスコードまたは POP エラーコード。有効な値： 2xx：リクエストは成功しました。 3xx：リクエストはリダイレクトされました。 4xx：クライアント側のエラーが発生しました。 5xx：サーバー側のエラーが発生しました。	200
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Status": 2,
    "SubStatus": 0,
    "ApprovalId": "67de0b39-a9d4-4c09-a170-cf438208****",
    "ErrorMessage": "success",
    "BatchWaitTime": 0,
    "CreateTime": "2020-12-17 21:06:45",
    "BatchCount": 1,
    "CoTypeCode": "CoRestartInstances",
    "SupportRollback": false,
    "ChangeOrderId": "765fa5c0-9ebb-4bb4-b383-1f885447**",
    "AppName": "app-test",
    "BatchType": "auto",
    "Description": "description",
    "CoType": "Batch Restart Instances",
    "Auto": true,
    "CurrentPipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****",
    "Pipelines": [
      {
        "Status": 2,
        "StartTime": 1562831689704,
        "UpdateTime": 1562847178007,
        "BatchType": 0,
        "ParallelCount": 0,
        "PipelineName": "Batch 1 Change",
        "PipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****"
      }
    ],
    "AppId": "bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****",
    "ApplicationUpdateStrategy": "",
    "ApplicationEnableGreyTagRoute": false
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	Resouce.no.permission	You are not authorized to operate on the specified resources.
400	InvalidChangeOrder.NotFound	The current change order does not exist.
404	InvalidAppId.NotFound	The specified AppId does not exist.

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

変更履歴

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