Updated on 2025-11-28 GMT+08:00

Obtaining the Release Task List

Function

This API is used to obtain the release task list.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    servicestage:pipeline:list

    list

    -

    -

    -

    -

URI

GET /v3/{project_id}/pipeline/pipelines

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication.

Response

Table 3 Response

Parameter

Type

Description

pipelines

Array of Object

Release task information. See Table 4.

Table 4 pipeline

Parameter

Type

Description

id

String

Release task ID.

name

String

Release task name.

description

String

Release task description.

create_time

Integer

Creation time of a release task.

update_time

Integer

Update time of a release task.

model_version

Integer

Release task model.

Only 2 is supported, indicating the new model.

config_mode

String

Release task deployment mode.

  • ui
  • template

status

Integer

Release task status.

  • 1: initialization successful
  • 2: release successful
  • 3: release failed
  • 4: releasing
  • 5: to be approved
  • 7: pause
  • 9: skip
  • 10: rolling back
  • 11: rollback successful
  • 12: rollback failed
  • 13: stopping
  • 14: restarting

creator

String

Creator.

last_trigger_at

Integer

Last execution time.

enterprise_project_id

String

Enterprise project ID.

Example Request

None

Example Response

[
    {
        "id": "4105b37a-947e-4aca-90d8-cec7c04c6f38",
        "name": "release-gn7mre",
        "description": "",
        "create_time": 1739865312582,
        "update_time": 1739865312582,
        "version": 1,
        "config_mode": "ui",
        "creator": "testcreator-3",
        "model_version": 2,
        "status": 1,
        "last_trigger_at": 0,
        "enterprise_project_id": "0",
        "enterprise_project": null,
        "extend_info": null
    }
]

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

See ServiceStage Error Codes.