更新时间:2022-04-16 GMT+08:00
分享

查询分组资源列表

功能介绍

该API用于查询某个project下的所有资源,其中包含Group。

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

    GET /v2.0/{project_id}/resources

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

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目编号,用于资源隔离。获取方式请参考获取项目ID

    表2 query参数说明

    参数名称

    是否必选

    参数类型

    说明

    kind

    String

    指定文件类型。

    tags

    String

    指定标签过滤。

请求消息

无请求参数。

响应消息

表3 响应参数说明

参数名称

是否必选

参数类型

说明

resources

Array of Objects

已上传的用户资源名列表, 资源详情请参见表4

modules

Array of Objects

系统内置资源模块列表,模块详情请参考表5

groups

Array of Objects

已上传的用户分组资源。

total

Integer

资源包返回总数。

表4 资源参数

参数名称

是否必选

参数类型

说明

create_time

Long

资源包上传的unix时间戳。

update_time

Long

更新已上传资源包的unix时间戳。

resource_type

String

资源类型。

resource_name

String

资源名。

status

String

  • "UPLOADING"表示正在上传。
  • "READY"表示资源包已上传 。
  • "FAILED"表示资源包上传失败。

underlying_name

String

资源包在队列中的名字。

owner

String

资源包拥有者。

表5 分组资源参数

参数名称

是否必选

参数类型

说明

module_name

String

模块名。

module_type

String

模块类型。

status

String

  • "UPLOADING"表示正在上传。
  • "READY"表示模块包已上传,。
  • "FAILED"表示模块包上传失败。

resources

Array of Strings

该模块包含的资源包名列表。

description

String

模块描述。

create_time

Long

模块上传的unix时间戳。

update_time

Long

模块更新的unix时间戳。

示例

  • 请求样例:
    None
  • 成功响应样例:
    {
        "resources": [
            {
                "create_time": 1521532893736,
                "update_time": 1521552364503,
                "resource_type": "jar",
                "resource_name": "luxor-router-1.1.1.jar",
                "status": "READY",
                "underlying_name": "3efffb4f-40e9-455e-8b5a-a23b4d355e46_luxor-router-1.1.1.jar"
            }
        ],
        "groups": [
            {
                "group_name": "groupTest",
                "status": "READY",
                "resources": [
                    "part-00000-9dfc17b1-2feb-45c5-b81d-bff533d6ed13.csv.gz",
                    "person.csv"
                ],
                "details": [
                    {
                        "create_time": 1547090015132,
                        "update_time": 1547090015132,
                        "resource_type": "jar",
                        "resource_name": "part-00000-9dfc17b1-2feb-45c5-b81d-bff533d6ed13.csv.gz",
                        "status": "READY",
                        "underlying_name": "db50c4dc-7187-4eb9-a5d0-73ba8102ea5e_part-00000-9dfc17b1-2feb-45c5-b81d-bff533d6ed13.csv.gz"
                    },
                    {
                        "create_time": 1547091098668,
                        "update_time": 1547091098668,
                        "resource_type": "file",
                        "resource_name": "person.csv",
                        "status": "READY",
                        "underlying_name": "a4243a8c-bca6-4e77-a968-1f3b00217474_person.csv"
                    }
                ],
                "create_time": 1547090015131,
                "update_time": 1547091098666
            }
        ],
        "modules": [
            {
                "module_name": "gatk",
                "status": "READY",
                "resources": [
                    "gatk.jar",
                    "tika-core-1.18.jar",
                    "s3fs-2.2.2.jar"
                ],
                "create_time": 1521532893736,
                "update_time": 1521552364503
            }
        ]
    }

状态码

状态码如表6所示。

表6 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

close