文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 产品实例/ 查询用户已开通产品实例列表
更新时间：2024-05-16 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询用户已开通产品实例列表

功能介绍

查询用户已开通产品实例列表。

URI

GET /v1/{project_id}/instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

是

Integer

偏移值。分页的偏移值，0代表不偏移，也就是第一页，1代表偏移1，指的第二页。

limit

是

Integer

返回列表数量。

sort_key

否

String

排序字段isOpen，是否开启行列权限。

sort_dir

否

String

排序类别：desc、asc。desc代表减序，asc代表升序。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

是

String

工作空间ID。

X-Auth-Token

是

String

用户Token。

Content-Type

是

String

固定值，指定请求体类型和字符集。

响应参数

表4 响应Body参数

参数

参数类型

描述

instances

Array of objects

实例信息。具体请参考表5。

count

Integer

数据数量。

page_data

Array of objects

当前页的数据。
表5 instances

参数

参数类型

描述

project_id

String

项目ID。

region_id

String

RegionId。

order_id

String

订单ID。

instance_id

String

产品实例ID。

instance_name

String

产品实例名称。

resource_spec_code

String

产品规格。

order_type

String

订单类型：

  • ON_DEMAND：按需。
  • PERIOD：包周期。

status

Integer

实例状态，有以下几种状态。

  • 1：未生效；
  • 2：生效中；
  • 3：已删除=退订；
  • 4：保留期=冻结；
  • 5：宽限期。

domain_id

String

账号ID。

eps_id

String

所属企业项目ID。

请求示例

GET https://{endpoint}/v1/{project_id}/instances

响应示例

获取已开通实例列表成功 。

{
  "count": 1,
  "page_data": [
    {
      "project_id": "9c3043ab4xxxx055888643b331a0xxxx",
      "region_id": "xxx",
      "order_id": "4xxxxd9517314ebbbe17258a9640xxxx",
      "instance_id": "4e7xxxx517314exxxx17258a9640c05f",
      "instance_name": "xxxx-4e7a0d9517314exxxx17258a9640c05f",
      "instance_spec_code": "DataArtsInsight.unit.enterprise.user",
      "order_type": "ON_DEMAND",
      "status": 2,
      "create_user": "***",
      "create_date": 169xxxx2604761,
      "domain_id": "d22f8acfxxxx428fb22606b64dc7xxxx",
      "eps_id": "0"
    }
  ]
}

状态码

状态码

描述

200

获取已开通实例列表成功。

错误码

请参见错误码。

父主题： 产品实例

相关文档