查询组织详情 - ShowOrganization

功能介绍

查询组织详情

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/organization

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID
instance_id	是	String	实例ID

表2 Query参数
参数	是否必选	参数类型	描述
name	是	String	组织名称

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
uid	String	36位uuid
name	String	组织名称，支持小写字母、数字，以小写字母开头
chain_org_id	String	交易状态
status	String	组织状态：正常（Available）、异常（Unavailable）、待付款（Unpaid）、创建中（Creating）、删除中（Deleting）
endpoint	String	besu链节点地址
is_consensus	Boolean	是否为共识组织，共识组织为true，非共识组织为false
capacity_info	OrgCapacityInfo object	组织磁盘容量相关信息
subscription_id	String	交易状态
order_info	OrgOrderInfo object	组织订购相关信息
countdown	OrgCountdownInfo object	组织资源倒计时信息
create_time	String	组织创建时间
update_time	String	组织数据更新时间

表5 OrgCapacityInfo
参数	参数类型	描述
total	Integer	组织单节点磁盘总容量，单位为MB
used	Integer	组织单节点磁盘使用容量，单位为MB

表6 OrgOrderInfo
参数	参数类型	描述
edition	String	版本类型:专业版（Professional）、企业版（Enterprise）、铂金版（Platinum）
charge_mode	Integer	资源计费模式:包周期计费（0）
period_type	Integer	订购周期类型:按月（2）、按年（3）
period_num	Integer	订购周期数量
is_auto_pay	Boolean	是否自动付款，true支持自动付款，false不支持自动付款
is_auto_renew	Boolean	是否自动续费，true支持自动续费，false不支持自动续费
promotion_id	String	促销活动ID，一次促销活动可包含多个促销计划，参与促销活动时必填
discount_plan_id	String	折扣计划ID，参与促销活动时必填

表7 OrgCountdownInfo
参数	参数类型	描述
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信息，包含资源生效、失效、冻结、释放时间以及宽限期到期时间

表8 CountdownInfos
参数	参数类型	描述
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	当前状态到下一步操作执行还剩下的秒数

表9 CountdownTips
参数	参数类型	描述
eff_time	String	资源生效时间
exp_time	String	资源失效时间
grace_time	String	资源宽限期结束时间
frozen_time	String	资源冻结时间
release_time	String	资源释放时间

状态码：400

**表10** 响应Body参数
参数	参数类型	描述
code	String	状态码
error_code	String	错误码
error_msg	String	错误信息
message	String	错误详细信息

状态码：401

**表11** 响应Body参数
参数	参数类型	描述
code	String	状态码
error_code	String	错误码
error_msg	String	错误信息
message	String	错误详细信息

状态码：500

**表12** 响应Body参数
参数	参数类型	描述
code	String	状态码
error_code	String	错误码
error_msg	String	错误信息
message	String	错误详细信息

请求示例

无

响应示例

状态码：200

请求成功

{
  "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"
}