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

获取实例列表

功能介绍

获取实例列表。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每次查询的数据连接条数的限制量,默认20。

offset

Integer

每次查询的数据连接条数的分页页码,默认0。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token认证时必选。通过调用ManageOne平台的IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

billing_check

Boolean

是否需要账单

count

Integer

返回记录总数

commodity_order_lists

Array of ApigCommodityOrder objects

返回实例列表。

表5 ApigCommodityOrder

参数

参数类型

描述

project_id

String

实例所属项目ID,获取方法请参见项目ID和账号ID

order_id

String

CBC订单id

region_id

String

通过调用ManageOne平台的IAM服务的“查询区域列表”接口获取响应消息中的区域ID。

resource_id

String

实例id

resource_name

String

实例名称

subscription_id

String

CBC订购id

resource_type

String

资源类型,hws.resource.type.dayu

resource_spec_code

String

产品规格编码(即实例类型编码),例如dayu.starter,dayu.basic,dayu.advanced等。可通过查询其他实例信息进行获取。

product_id

String

CBC产品id,未安装CBC的环境无需这个值

order_type

String

订单类型标识符

charge_type

String

支付选项,留空

is_auto_renew

Integer

自动续费标识,当前实例为按需支付时必填,0代表不续费,1代表自动续费

status

Integer

实例状态,1未生效2生效中3已删除=退订4保留期=冻结5宽限期6删除中

vpc_id

String

虚拟私有云id,可在当前虚拟私有云列表中获取

security_group_id

String

安全组id,可在当前安全组列表中获取

eps_id

String

企业项目ID,获取方法请参见项目ID和账号ID

effective_time

Number

生效时间点,包周期实例有效

expire_days

String

过期时间天数,包周期实例有效

expire_time

Number

过期时间点,包周期有效

lock_check_endpoint

String

CBC锁定节点域名

create_user

String

创建用户

create_time

Number

创建时间点

domain_id

String

用户domain id

is_trial_order

Integer

是否试用订单

work_space_mode

String

工作空间模式说明

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

返回的错误信息。

error_code

String

返回的错误码。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_msg

String

返回的错误信息。

error_code

String

返回的错误码。

请求示例

响应示例

状态码: 400

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed, detail msg {0}."
}

状态码: 500

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

状态码

状态码

描述

200

Success,返回DataArtsStudio实例列表。

400

BadRequest

500

Internal Server Error

分享:

    相关文档

    相关产品