すべてのプロダクト
Search

このプロダクト

    Serverless App Engine:DescribePipeline

    ドキュメントセンター

    Serverless App Engine:DescribePipeline

    最終更新日:Apr 22, 2026

    バッチ情報を表示します。

    今すぐお試しください

    この 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:DescribePipeline

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    PipelineId

    string

    必須

    バッチの ID です。DescribeChangeOrder 操作を呼び出して ID を取得できます。

    917660ba-5092-44ca-b8e0-80012c96****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    バッチ情報のレスポンスボディです。

    RequestId

    string

    リクエスト ID です。

    559B4247-C41C-4D9E-B866-B55D360B****
    Message

    string

    操作に対して返されるメッセージです。

    success
    TraceId

    string

    リクエストの詳細を照会するために使用されるトレース ID です。

    0be3e0c316390414649128666e****
    Data

    object

    バッチ情報です。

    ShowBatch

    boolean

    次のバッチの処理を開始するかどうかを示します。 有効な値：

    • false：次のバッチはまだ処理できないことを示します。

    • true：次のバッチを今すぐ処理できることを示します。

    false
    PipelineStatus

    integer

    バッチのステータス。 有効な値：

    • 0：バッチは処理の準備ができています。

    • 1：タスクは実行中です。

    • 2：成功。

    • 3：このステージでの処理は失敗しました。

    • 6：バッチ処理は終了しました。

    • 10：システム例外のため、バッチを処理できませんでした。

    2
    CurrentStageId

    string

    バッチ処理ステージの ID です。

    c3a55592-4c30-4d84-ac2d-e98c18ec****
    PipelineName

    string

    バッチの名前です。

    First batch
    StageList

    array<object>

    バッチ処理ステージのリストです。

    array<object>

    ステージに関する情報です。

    Status

    integer

    バッチ処理ステージのステータス。 有効な値：

    • 0：バッチはこの処理ステージの準備ができています。

    • 1：タスクは実行中です。

    • 2：成功。

    • 3：このステージでの処理は失敗しました。

    • 6：処理ステージは終了しました。

    2
    StageId

    string

    ステージの ID です。

    c3a55592-4c30-4d84-ac2d-e98c18ec****
    ExecutorType

    integer

    ステージの実行タイプ。 有効な値：

    • 0：順次。

    • 1：並列。

    0
    TaskList

    array<object>

    タスクステータスのリストです。

    object

    タスクステータスに関する情報です。

    Status

    integer

    タスクのステータス。 有効な値：

    • 0：タスクは実行の準備ができています。

    • 1：タスクは実行中です。

    • 2：成功。

    • 3：タスクを実行できませんでした。

    • 5：タスクは再試行待ちです。

    • 6：タスクは終了しました。

    2
    StageId

    string

    ステージの ID です。

    c3a55592-4c30-4d84-ac2d-e98c18ec****
    ErrorMessage

    string

    タスクを実行できなかった場合に返されるエラーメッセージです。 タスクが正常に実行された場合、このパラメーターは返されません。

    EDAS-10022

    ErrorCode

    string

    タスクを実行できなかった場合に返されるエラーコードです。 タスクが正常に実行された場合、このパラメーターは返されません。

    EDAS-10022
    TaskName

    string

    タスクの名前です。

    Environment initialization
    ErrorIgnore

    integer

    タスクが失敗した場合に後続のタスクを実行するかどうかを示します。 有効な値：

    • 0：後続のタスクは実行できません。

    • 1：後続のタスクを実行できます。

    0
    Message

    string

    タスク実行結果を示す返されたメッセージです。

    init Namespace success
    ShowManualIgnore

    boolean

    実行中のタスクを手動でスキップできるかどうかを示します。有効な値は次のとおりです：

    • true：実行中のタスクはスキップできます。

    • false：実行中のタスクはスキップできません。

    false
    TaskId

    string

    タスクの ID です。

    bef0122f-de9a-4ab0-8223-b88bf8ad****
    StageName

    string

    ステージの名前です。

    Application Deployment
    NextPipelineId

    string

    次のバッチの ID です。

    b77b1c98-5772-4f05-95fc-c7bee5fa****
    PipelineId

    string

    バッチの ID です。

    917660ba-5092-44ca-b8e0-80012c96****
    CoStatus

    string

    バッチの変更オーダーのステータスです。

    Executed successfully
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコードです。 次のルールにご注意ください：

    • リクエストが成功した場合、ErrorCode パラメーターは返されません。

    • 呼び出しが失敗した場合、ErrorCode パラメーターが返されます。 詳細については、このトピックの「エラーコード」セクションをご参照ください。

    Code

    string

    HTTP ステータスコード。 有効な値：

    • 2xx：呼び出しは成功しました。

    • 3xx：呼び出しはリダイレクトされました。

    • 4xx：呼び出しは失敗しました。

    • 5xx：サーバーエラーが発生しました。

    200
    Success

    boolean

    バッチ情報が取得されたかどうかを示します。 有効な値：

    • true：情報が照会されました。

    • false：イメージの検索に失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "559B4247-C41C-4D9E-B866-B55D360B****",
  "Message": "success",
  "TraceId": "0be3e0c316390414649128666e****",
  "Data": {
    "ShowBatch": false,
    "PipelineStatus": 2,
    "CurrentStageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
    "PipelineName": "First batch",
    "StageList": [
      {
        "Status": 2,
        "StageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
        "ExecutorType": 0,
        "TaskList": [
          {
            "Status": 2,
            "StageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
            "ErrorMessage": "EDAS-10022 ",
            "ErrorCode": "EDAS-10022",
            "TaskName": "Environment initialization",
            "ErrorIgnore": 0,
            "Message": "init Namespace success",
            "ShowManualIgnore": false,
            "TaskId": "bef0122f-de9a-4ab0-8223-b88bf8ad****"
          }
        ],
        "StageName": "Application Deployment"
      }
    ],
    "NextPipelineId": "b77b1c98-5772-4f05-95fc-c7bee5fa****",
    "PipelineId": "917660ba-5092-44ca-b8e0-80012c96****",
    "CoStatus": "Executed successfully"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParameter.NotEmpty You must specify the parameter %s.
    400 InvalidParameter.NoPermission Resource no permission

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

    変更履歴

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