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

查询实例列表

功能介绍

查询区块链实例列表，单次最多查询100个

URI

GET /v2/{project_id}/huaweicloudchain/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

分页查询起始位置

limit

否

Integer

每页返回的条目数量

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

实例总数量

instances

Array of InstanceInfo objects

实例列表
表5 InstanceInfo

参数

参数类型

描述

id

String

实例ID

name

String

实例名称

status

String

实例状态：正常（Available）、不可用（Unavailable）、异常（Exception）、待付款（Unpaid）、创建中（Creating）、删除中（Deleting）、升级中（Upgrading）、组织创建中（OrgCreating）、组织删除中（OrgDeleting）

edition

String

版本类型: 专业版（Professional）、企业版（Enterprise）、铂金版（Platinum）

kind

String

实例类型，HuaweiCloudChain，Besu

data_management

String

数据管理模式：云端管理（Cloud）

chain_engine_version

String

实例区块链引擎版本

orgs

Array of InstanceOrg objects

实例组织信息

chains

Array of InstanceChain objects

实例链信息

create_time

String

实例创建时间

update_time

String

实例数据更新时间

enterprise_project_id

String

企业项目id

enterprise_project_name

String

企业项目名称
表6 InstanceOrg

参数

参数类型

描述

name

String

组织名称

status

String

组织状态：正常（Available）、不可用（Unavailable）、异常（Exception）、待付款（Unpaid）、创建中（Creating）、删除中（Deleting）

is_consensus

Boolean

是否为共识组织，共识组织为true，非共识组织为false
表7 InstanceChain

参数

参数类型

描述

chain_id

String

链ID

consensus

ConsensusType object

区块链共识类型：raft

sign_algorithm

String

区块链签名算法：ECDSA（ecdsa_with_sha256）、国密（sm2_with_sm3）

contract_num

Integer

合约数量

block_num

Integer

区块数量

transaction_num

Integer

交易数量
表8 ConsensusType

参数

参数类型

描述

-

String

区块链共识类型：raft,IBFT2.0

状态码： 400

表9 响应Body参数

参数

参数类型

描述

code

String

状态码

error_code

String

错误码

error_msg

String

错误信息

message

String

错误详细信息

状态码： 401

表10 响应Body参数

参数

参数类型

描述

code

String

状态码

error_code

String

错误码

error_msg

String

错误信息

message

String

错误详细信息

状态码： 500

表11 响应Body参数

参数

参数类型

描述

code

String

状态码

error_code

String

错误码

error_msg

String

错误信息

message

String

错误详细信息

请求示例

无

响应示例

状态码： 200

请求成功

{
  "count" : 1,
  "instances" : [ {
    "id" : "e543adf0-c61e-11ec-a1c5-0255ac100408",
    "name" : "huawei-chain-01",
    "status" : "Available",
    "edition" : "Professional",
    "data_management" : "Cloud",
    "chain_engine_version" : "1.0.1.2",
    "orgs" : [ {
      "name" : "org1",
      "status" : "Available",
      "is_consensus" : true
    }, {
      "name" : "org2",
      "status" : "Available",
      "is_consensus" : false
    } ],
    "chains" : [ {
      "chain_id" : "huawei-chain-01-egger394n",
      "consensus" : "raft",
      "sign_algorithm" : "ecdsa_with_sha256",
      "contract_num" : 1,
      "block_num" : 5,
      "transaction_num" : 9
    } ],
    "create_time" : "2022-04-16T07:20:05Z",
    "update_time" : "2022-04-16T07:20:05Z",
    "enterprise_project_id" : "0",
    "enterprise_project_name" : "default"
  } ]
}

状态码

状态码

描述

200

请求成功

400

请求参数校验不通过

401

鉴权失败

500

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

相关文档