更新时间:2023-08-18 GMT+08:00
分享

查询job列表

功能介绍

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

URI

GET /v2/{project_id}/huaweicloudchain/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:32

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

status

String

job状态:初始化(Initializing)、运行中(Running)、失败(Failed)、成功(Success);支持多个状态联合查询,以逗号分隔

最小长度:6

最大长度:40

start_time

String

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

最小长度:1

最大长度:32

instance_name

String

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

最小长度:1

最大长度:24

offset

Integer

分页查询起始位置

最小值:0

limit

Integer

每页返回的条目数量

最小值:1

最大值:100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token

最小长度:1

最大长度:65535

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

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

最小值:0

最大值:2000

jobs

Array of JobInfo objects

job列表

数组长度:0 - 2000

表5 JobInfo

参数

参数类型

描述

id

String

job ID

type

String

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

枚举值:

  • CreateInstance

  • DeleteInstance

  • UpgradeChainEngine

  • CreateOrganization

  • DeleteOrganization

status

String

job状态:初始化(Initializing)、运行中(Running)、失败(Failed)、成功(Success)

枚举值:

  • Initializing

  • Running

  • Failed

  • Success

failed_message

String

job失败详细描述信息

progress

Integer

job完成百分比

最小值:0

最大值:100

instance_id

String

job相关的实例ID

instance_name

String

job相关的实例名称

start_time

String

job起始时间

end_time

String

job结束时间

状态码: 400

表6 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度:3

最大长度:3

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:1

最大长度:65535

message

String

错误详细信息

最小长度:1

最大长度:65535

状态码: 401

表7 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度:3

最大长度:3

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:1

最大长度:65535

message

String

错误详细信息

最小长度:1

最大长度:65535

状态码: 500

表8 响应Body参数

参数

参数类型

描述

code

String

状态码

最小长度:3

最大长度:3

error_code

String

错误码

最小长度:12

最大长度:12

error_msg

String

错误信息

最小长度:1

最大长度:65535

message

String

错误详细信息

最小长度:1

最大长度:65535

请求示例

响应示例

状态码: 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

服务内部执行错误

分享:

    相关文档

    相关产品