文档首页/ 区块链服务 BCS/ API参考/ 华为云区块链引擎管理/ API(华为云区块链引擎)/ 任务管理/ 查询job列表
更新时间：2024-11-14 GMT+08:00
查看PDF
分享

查询job列表

功能介绍

查询租户job列表，单次最多查询100个

URI

GET /v2/{project_id}/huaweicloudchain/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

status

否

String

job状态：初始化（Initializing）、运行中（Running）、失败（Failed）、成功（Success）；支持多个状态联合查询，以逗号分隔

start_time

否

String

查询job起始UTC时间，格式为RFC 3339标准时间格式，eg:2022-07-07T13:00:29Z

instance_name

否

String

Job关联实例名称，支持模糊查询，区分大小写

offset

否

Integer

分页查询起始位置

limit

否

Integer

每页返回的条目数量

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

符合条件的job总数量，最大1000

jobs

Array of JobInfo objects

job列表
表5 JobInfo

参数

参数类型

描述

id

String

job ID

type

String

job类型：创建实例（CreateInstance）、删除实例（DeleteInstance）、升级区块链引擎（UpgradeChainEngine）、创建组织（CreateOrganization）、删除组织（DeleteOrganization）

status

String

job状态：初始化（Initializing）、运行中（Running）、失败（Failed）、成功（Success）

failed_message

String

job失败详细描述信息

progress

Integer

job完成百分比

instance_id

String

job相关的实例ID

instance_name

String

job相关的实例名称

start_time

String

job起始时间

end_time

String

job结束时间

状态码： 400

表6 响应Body参数

参数

参数类型

描述

code

String

状态码

error_code

String

错误码

error_msg

String

错误信息

message

String

错误详细信息

状态码： 401

表7 响应Body参数

参数

参数类型

描述

code

String

状态码

error_code

String

错误码

error_msg

String

错误信息

message

String

错误详细信息

状态码： 500

表8 响应Body参数

参数

参数类型

描述

code

String

状态码

error_code

String

错误码

error_msg

String

错误信息

message

String

错误详细信息

请求示例

无

响应示例

状态码： 200

请求成功

{
  "count" : 1,
  "jobs" : [ {
    "id" : "a75e800b-bd4c-11ec-a5fe-0255ac100409",
    "type" : "CreateInstance",
    "status" : "Success",
    "failed_message" : "",
    "progress" : 100,
    "instance_id" : "37f60ab6-bbeb-11ec-9396-0255ac100408",
    "instance_name" : "cce-test-01",
    "start_time" : "2022-04-16T07:20:05Z",
    "end_time" : "2022-04-16T07:40:05Z"
  } ]
}

状态码

状态码

描述

200

请求成功

400

请求参数校验不通过

401

鉴权失败

500

服务内部执行错误
父主题： 任务管理

相关文档