更新时间:2025-07-25 GMT+08:00
分享

查询流水线环境详情

功能介绍

此API用于查询流水线的环境。

URI

GET /cpepipeline/v2/environments/{environment_id}

参数说明见表1

表1 路径参数

参数

是否必选

参数类型

描述

environment_id

String

构建任务实例ID。获取方法,请参考创建流水线环境

请求消息

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式),默认取值为“application/json;charset=utf8”。

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考获取用户Token

响应消息

表3 响应参数

参数

参数类型

描述

id

String

环境ID。

name

String

环境名称。

creator

String

环境创建者。

revisor

String

环境保存者。

created_at

Integer

创建时间。

updated_at

Integer

更新时间。

status

Integer

环境状态。

project_id

String

项目ID。

detail

String

环境详细信息,详情请见表4

表4 detail

参数

参数类型

描述

name

String

环境名称。

tasks

String

环境任务,详情请见表5

表5 tasks

参数

参数类型

描述

id

Integer

任务ID。

name

String

任务名称。

displayName

String

任务显示名称。

input

Object

任务输入参数,详情请见表7

status

Integer

任务状态。

errorDetails

String

任务报错信息。

stageName

String

阶段类型。

taskTypeId

Object

任务类型参数,详情请见表6

表6 taskTypeId

参数

参数类型

描述

category

String

任务目录。

owner

String

任务所有者。

provider

String

任务提供方。

type

String

任务类型。

表7 input

参数

参数类型

描述

instanceId

String

组件实例ID。

appName

String

组件名称。

modifiedPath

String

产物路径。

version

String

修改版本。

响应示例

{
    "id": "805f7ec2-7c05-417b-bc3e-5f6035edb673",
    "name": "Environment-894g",
    "creator": "servicestage_iam5",
    "revisor": "servicestage_iam5",
    "created_at": 1753165301070,
    "updated_at": 1753165301070,
    "status": 0,
    "project_id": "59336be373624a998b2527fdb9913266",
    "detail": {
        "name": "Environment-894g",
        "tasks": [
            {
                "id": 0,
                "name": "Deploy",
                "displayName": "Deploy",
                "taskTypeId": {
                    "category": "Deploy",
                    "owner": "System",
                    "provider": "ENV-CAS",
                    "type": null
                },
                "input": {
                    "instanceId": "20acd377-0659-478c-b563-c2585166278e",
                    "appName": "ghy-test-0707-1-2",
                    "modifiedPath": "{\"ghy-test-0707-1-2\":\"${Artifacts_ghy-test-comp-0626-3-62e353_Output_release@PublishBuildImage}\"}",
                    "version": "1.0.0"
                },
                "output": {},
                "status": null,
                "skipped": false
            }
        ]
    }
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

请参考ServiceStage错误码

相关文档