更新时间:2024-03-25 GMT+08:00
分享

查询指定发布包详情

功能介绍

用于查询指定的发布包详情信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。

URI

  • URI格式

    GET /v2/{project_id}/factory/release-packages/{package_id}

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,获取方法请参见项目ID和账号ID

    package_id

    String

    发布包ID。获取方法请参考“查询发布包列表”的响应参数“package_id”。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

String

工作空间id。

  • 如果不设置该参数,默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据,需要带上该消息头。

X-Auth-Token

String

使用Token认证时该字段必选,用户Token的长度要求如下:

最小长度:0

最大长度:4096

Content-Type

String

有Body体的情况下必选,无Body体的情况下则无需填写和校验。

示例:Content-Type: application/json;charset=UTF-8

Authorization

String

使用AK/SK进行认证时该字段必选。

Host

String

使用AK/SK进行认证时该字段必选。

响应参数

表3 参数说明

参数名

是否必选

参数类型

说明

release_package

object

发布包详情,参考表4

task_details

array[object]

发布任务详情,参考表5

表4 发布包详情的参数说明

参数名

是否必选

参数类型

说明

apply_timestamp

Long

申请时间,13位时间戳。

apply_user_id

String

申请人id。

apply_user_name

String

申请人名称。

delete_flag

integer

是否删除。

0:没有删除

1:删除

deploy_status

integer

发布状态。

1:待审批

2:成功

3:失败

5:发布中

deploy_timestamp

Long

发布时间,13位时间戳。

deploy_user_id

String

发布人id。

deploy_user_name

String

发布人名称。

package_approvers

array[object]

发布包审批信息,参考表6

package_id

String

发布包id。

package_name

String

发布包名称。

project_id

String

项目ID和空间信息,以项目ID-workspace-空间ID拼接。

workspace_id

String

发布包所在空间ID。

表5 发布任务详情的参数说明

参数名

是否必选

参数类型

说明

deploy_status

integer

发布状态。

1:待审批

2:成功

3:失败

5:发布中

deployed_version

integer

已发布节点版本。

item_name

String

发布任务名称。

pending_item_id

String

发布任务ID。

pending_version

integer

当前节点版本。

script_id

String

脚本ID。

task_id

String

作业ID。

start_job_status

integer

作业启动状态。

2:成功

3:失败

submit_timestamp

Long

提交时间戳,13位时间戳。

submit_user_id

String

提交人id。

submit_user_name

String

提交人名称。

task_type

integer

任务类型。

1:作业

2:脚本

3:资源

update_type

integer

变更类型,默认值1。

1:新增

2:修改

3:删除

表6 发布包审批信息的参数说明

参数名

是否必选

参数类型

说明

user_id

String

发布包审批人id。

user_name

String

发布包审批人名称。

请求示例

GET /v2/62099355b894428e8916573ae635f1f9/factory/release-packages/1

响应示例

  • 成功响应

    HTTP状态码 200

    {
        "release_package": {
            "apply_timestamp": 1700288912934,
            "apply_user_id": "7b71e498e75d44048c9a22dd3c54f978",
            "apply_user_name": "ei_dlf_l00341563",
            "delete_flag": 0,
            "deploy_status": 3,
            "deploy_timestamp": 1700289155129,
            "deploy_user_id": "7b71e498e75d44048c9a22dd3c54f978",
            "deploy_user_name": "ei_dlf_l00341563",
            "package_approvers": [
                {
                    "user_id": "7b71e498e75d44048c9a22dd3c54f978",
                    "user_name": "ei_dlf_l00341563"
                }
            ],
            "package_id": "4",
            "package_name": "ads_supplier_inventory_info__ads_supplier_inventory_info_20231118143537",
            "project_id": "62099355b894428e8916573ae635f1f9-workspace-45be704b28cb4f25a39221169fd3e27e",
            "workspace_id": "45be704b28cb4f25a39221169fd3e27e"
        },
        "task_details": [
            {
                "deploy_status": 3,
                "deployed_version": 0,
                "item_name": "ads_supplier_inventory_info__ads_supplier_inventory_info",
                "pending_item_id": "19",
                "pending_version": 1,
                "script_id": "ff808081899c04fa01899fc39cf61baa",
                "submit_timestamp": 1690602544380,
                "submit_user_id": "7b71e498e75d44048c9a22dd3c54f978",
                "submit_user_name": "ei_dlf_l00341563",
                "task_type": 2,
                "update_type": 1
            }
        ]
    }
  • 失败响应

    HTTP状态码 400

    {
        "error_code": "DLF.3051",
        "error_msg": "The request parameter is invalid.  "
    }
分享:

    相关文档

    相关产品