更新时间:2024-10-29 GMT+08:00
分享

查询发布包列表

功能介绍

用于查询发布包的列表信息。

调试

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

URI

  • URI格式

    POST /v2/{project_id}/factory/release-packages

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,获取方法请参见项目ID和账号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 Body参数说明

参数名

是否必选

参数类型

说明

key_word

String

包名package_name关键字。

apply_user_name

String

申请人名称。

deploy_user_name

String

发布人名称。

apply_begin_time

Long

申请开始时间,13位时间戳。

apply_end_time

Long

申请结束时间,13位时间戳。

deploy_begin_time

Long

发布开始时间,13位时间戳。

deploy_end_time

Long

发布结束时间,13位时间戳。

apply_user_name_filter

array[string]

申请人名称集合,根据该字段筛选,如果选择了apply_user_name,则该名称必须包含在集合内。

deploy_user_name_filter

array[string]

发布人名称集合,根据该字段筛选,如果选择了deploy_user_name,则该名称必须包含在集合内。

deploy_status_filter

array[integer]

发布状态集合。

1:待审批

2:成功

3:失败

5:发布中

sorted_direction

String

排序方向,默认是desc。

order_column

String

排序字段,默认是apply_timestamp。

limit

Integer

分页返回结果,默认是10。

offset

Integer

分页的起始页,默认值为0,取值范围大于等于0。

响应参数

表4 参数说明

参数名

是否必选

参数类型

说明

data

array[object]

发布包信息,参考表5

total

Integer

发布包个数。

表5 发布包信息的参数说明

参数名

是否必选

参数类型

说明

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。

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

参数名

是否必选

参数类型

说明

user_id

String

发布包审批人id。

user_name

String

发布包审批人名称。

请求示例

POST /v2/62099355b894428e8916573ae635f1f9/factory/packages
{
	"key_word": "",
	"apply_user_name": "",
	"deploy_user_name": "",
        "apply_begin_time": 1699113600999,
	"apply_end_time": 1700323199999,
	"deploy_begin_time": "",
	"deploy_end_time": "",
	"apply_user_name_filter": "",
	"deploy_user_name_filter": "",
	"deploy_status_filter": "",
	"sorted_direction": "desc",
	"order_column": "apply_timestamp",
	"limit": 10,
	"offset": 0
}

响应示例

  • 成功响应

    HTTP状态码 200

    {
        "data": [
            {
                "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"
            },
            {
                "apply_timestamp": 1700288777664,
                "apply_user_id": "7b71e498e75d44048c9a22dd3c54f978",
                "apply_user_name": "ei_dlf_l00341563",
                "delete_flag": 0,
                "deploy_status": 2,
                "deploy_timestamp": 1700289161361,
                "deploy_user_id": "7b71e498e75d44048c9a22dd3c54f978",
                "deploy_user_name": "ei_dlf_l00341563",
                "package_approvers": [
                    {
                        "user_id": "7b71e498e75d44048c9a22dd3c54f978",
                        "user_name": "ei_dlf_l00341563"
                    }
                ],
                "package_id": "3",
                "package_name": "aa_20231118143318",
                "project_id": "62099355b894428e8916573ae635f1f9-workspace-45be704b28cb4f25a39221169fd3e27e",
                "workspace_id": "45be704b28cb4f25a39221169fd3e27e"
            }
        ],
        "total": 2
    }
  • 失败响应

    HTTP状态码 400

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

相关文档