全部產品
Search

搜尋本產品

    ：DescribePipeline - 擷取Logstash執行個體的管道資訊

    文件中心

    ：DescribePipeline - 擷取Logstash執行個體的管道資訊

    更新時間：Mar 17, 2026

    查看批次資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    sae:DescribePipeline

    get

    *全部資源

    *

    		 無 無

    請求文法

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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    PipelineId

    string

    是

    批次 ID。通過調用 DescribeChangeOrder 介面擷取。

    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

    批次名稱。

    第1批變更
    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

    任務名稱。

    初始化環境
    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

    階段的名稱。

    部署應用
    NextPipelineId

    string

    下一批次 ID。

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

    string

    批次 ID。

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

    string

    該批次所在的變更單的狀態。

    執行成功
    ErrorCode

    string

    錯誤碼。取值說明如下：

    • 請求成功：不返回 ErrorCode 欄位。

    • 請求失敗：返回 ErrorCode 欄位。具體資訊，請參見本文的錯誤碼列表。

    空
    Code

    string

    介面狀態或 POP 錯誤碼。取值說明如下：

    • 2xx：成功。

    • 3xx：重新導向。

    • 4xx：請求錯誤。

    • 5xx：伺服器錯誤。

    200
    Success

    boolean

    查詢批次資訊是否成功。取值說明如下：

    • true：查詢成功。

    • false：查詢失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "559B4247-C41C-4D9E-B866-B55D360B****",
  "Message": "success",
  "TraceId": "0be3e0c316390414649128666e****",
  "Data": {
    "ShowBatch": false,
    "PipelineStatus": 2,
    "CurrentStageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
    "PipelineName": "第1批變更",
    "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": "初始化環境",
            "ErrorIgnore": 0,
            "Message": "init Namespace success",
            "ShowManualIgnore": false,
            "TaskId": "bef0122f-de9a-4ab0-8223-b88bf8ad****"
          }
        ],
        "StageName": "部署應用"
      }
    ],
    "NextPipelineId": "b77b1c98-5772-4f05-95fc-c7bee5fa****",
    "PipelineId": "917660ba-5092-44ca-b8e0-80012c96****",
    "CoStatus": "執行成功"
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParameter.NotEmpty You must specify the parameter %s. 不合法的參數：%s不可為空。
    400 InvalidParameter.NoPermission Resource no permission 請求資源無許可權

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。