查询组织列表
功能介绍
查询实例组织列表，单次最多查询100个
URI
GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/organizations
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
instance_id |
是 |
String |
实例ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
分页查询起始位置 |
|
limit |
否 |
Integer |
每页返回的条目数量 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
组织总数量 |
|
orgs |
Array of OrgInfo objects |
实例列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
uid |
String |
组织资源ID |
|
name |
String |
组织名称 |
|
chain_org_id |
String |
组织在链上的ID |
|
status |
String |
组织状态：正常（Available）、异常（Exception）、不可用（Unavailable）、待付款（Unpaid）、创建中（Creating）、删除中（Deleting） |
|
endpoint |
String |
besu链节点地址 |
|
is_consensus |
Boolean |
是否为共识组织，共识组织为true，非共识组织为false |
|
capacity_info |
OrgCapacityInfo object |
组织磁盘容量相关信息 |
|
subscription_id |
String |
资源对应的订购实例ID，可用于组织退订 |
|
order_info |
OrgOrderInfo object |
组织订购相关信息 |
|
countdown |
OrgCountdownInfo object |
组织资源倒计时信息 |
|
create_time |
String |
组织创建时间 |
|
update_time |
String |
组织数据更新时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
edition |
String |
版本类型: 专业版（Professional）、企业版（Enterprise）、铂金版（Platinum） |
|
charge_mode |
Integer |
资源计费模式:包周期计费（0） |
|
period_type |
Integer |
订购周期类型:按月（2）、按年（3） |
|
period_num |
Integer |
订购周期数量，按年只允许购买一年，按月可以购买1-9个月，超过9个月等同于一年 |
|
is_auto_pay |
Boolean |
是否自动付款，true支持自动付款，false不支持自动付款 |
|
is_auto_renew |
Boolean |
是否自动续费，true支持自动续费，false不支持自动续费 |
|
promotion_id |
String |
资源购买参与促销时的促销活动ID，未参与则为空值；一次促销活动可包含多个促销计划 |
|
discount_plan_id |
String |
资源购买参与促销时的折扣计划ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
countdown_code |
String |
包周期资源各状态倒计时呈现Code：正常状态（hws_countdown_period_using）、到期进入宽限期（hws_countdown_period_gracing）、到期冻结（hws_countdown_period_frozen）、违规冻结（hws_countdown_period_illegalfrozen）、公安冻结（hws_countdown_period_policefrozen） |
|
countdown_infos |
CountdownInfos object |
倒计时信息，包含资源状态、到期处理策略、到期剩余时间 |
|
countdown_tips |
CountdownTips object |
倒计时tips信息，包含资源生效、失效、冻结、释放时间以及宽限期到期时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
Integer |
资源当前状态：未生效（1）、生效中（2）、已删除（3）、冻结中（4）、宽限期中（5）、违规冻结或公安冻结（99） |
|
next_operation_policy |
Integer |
下一步操作的处理策略/到期处理策略：到期进入宽限期（0）、无宽限期和保留期场景到期后自动删除（2）、宽限期到期冻结（4）、宽限期到期后删除（5） |
|
next_operation_remaining_day |
Integer |
当前状态到下一步操作执行还剩下的天数 |
|
next_operation_remaining_hour |
Integer |
当前状态到下一步操作执行还剩下的小时数 |
|
next_operation_remaining_minute |
Integer |
当前状态到下一步操作执行还剩下的分钟数 |
|
next_operation_remaining_second |
Integer |
当前状态到下一步操作执行还剩下的秒数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
eff_time |
String |
资源生效时间 |
|
exp_time |
String |
资源失效时间 |
|
grace_time |
String |
资源宽限期结束时间 |
|
frozen_time |
String |
资源冻结时间 |
|
release_time |
String |
资源释放时间 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
状态码 |
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
message |
String |
错误详细信息 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
状态码 |
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
message |
String |
错误详细信息 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
状态码 |
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
|
message |
String |
错误详细信息 |
请求示例
无
响应示例
状态码： 200
请求成功
{
"count" : 1,
"orgs" : [ {
"uid" : "f1766f8b-c55a-11ec-a67c-0255ac10040d",
"name" : "org1",
"chain_org_id" : "org1-f8587hwjt",
"status" : "Available",
"is_consensus" : true,
"capacity_info" : {
"total" : 512000,
"used" : 102400
},
"subscription_id" : "01154-360000102-0",
"order_info" : {
"edition" : "Professional",
"charge_mode" : 0,
"period_type" : 2,
"period_num" : 1,
"is_auto_pay" : true,
"is_auto_renew" : true
},
"countdown" : {
"countdown_code" : "hws_countdown_period_using",
"countdown_infos" : {
"status" : 2,
"next_operation_policy" : 0,
"next_operation_remaining_day" : 28
},
"countdown_tips" : {
"eff_time" : "2022-04-26T12:37:16Z",
"exp_time" : "2022-05-26T15:59:59Z"
}
},
"create_time" : "2022-04-16T07:20:05Z",
"update_time" : "2022-04-16T07:20:05Z"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
请求参数校验不通过 |
|
401 |
鉴权失败 |
|
500 |
服务内部执行错误 |
