根据发布单ID获取发布单部署信息 - ObtainDeploymentInformationAboutReleaseTaskBasedOnTheReleaseTaskID

功能介绍

此API用来根据发布单ID获取发布单部署信息。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
servicestage::getReleasePlan
read
-
-
servicestage:app:get
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
servicestage::getReleasePlan	read	-	-	servicestage:app:get	-

URI

GET /v3/{project_id}/cas/release-plans/{release_plan_id}/deploy-info

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户项目ID。获取方法，请参考获取项目ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及
release_plan_id	是	String	参数解释：发布单ID。获取方法，请参考获取发布单列表 - ObtainReleaseTaskList。约束限制：不涉及取值范围：不涉及默认取值：不涉及

请求消息

表2 请求Header参数
参数	是否必选	参数类型	描述
Content-Type	是	String	参数解释：消息体的类型（格式）。约束限制：不涉及取值范围： application/json;charset=utf8 默认取值：不涉及
X-Auth-Token	是	String	参数解释：调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应消息

表3 响应参数
参数	参数类型	描述
id	String	发布单ID。
components	Array of objects	组件发布信息，请参考表4。

表4 job_info
参数	参数类型	描述
job_id	String	Job ID。
status	String	发布组件状态。 SUCCESS，成功。 CREATED，已创建。 FAILED，失败。 PARTIALLY_FAILED，部分失败。 ROLLBACK_FAILED，回滚失败。 ROLLBACK_SUCCEED，回滚成功。 ABORTED，操作中止。
job_status	String	Job状态。 CREATED，已创建。 FAILED，失败。 RUNNING，运行中。 SUCCEEDED，完成。
name	String	发布组件名称。
id	String	发布组件ID。
seq	String	发布组件批次。
version	String	发布组件版本。
rollback_job_id	String	回滚Job ID。
start_time	Long	组件发布开始时间。
end_time	Long	组件发布结束时间。
rollback_job_status	String	回滚Job状态。 FAILED，失败。 SUCCEEDED，完成。
rollback_start_time	String	回滚组件发布开始时间。
rollback_end_time	String	回滚组件发布结束时间。
fail_message	String	失败信息。
rollback_fail_message	String	回滚失败信息。

请求示例

无

响应示例

{
    "id": "716eda33-dbc6-47f3-953f-29119edd5e5c",
    "components": [
        {
            "job_id": "JOB6999c66d-cb39-4c46-9f98-893b704300e0",
            "status": "RUNNING",
            "job_status": "SUCCEEDED",
            "name": "sch",
            "id": "df49e875-000c-4d69-8f45-c4f384549e1b",
            "seq": 1,
            "version": "2024.0802.18390",
            "rollback_job_id": null,
            "start_time": 1722933924962,
            "end_time": 1722933950018,
            "rollback_job_status": null,
            "rollback_start_time": 0,
            "rollback_end_time": 0,
            "fail_message": null,
            "rollback_fail_message": null
        }
    ]
}