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

功能介绍

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/instances

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。获取方法请参见获取项目ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及

表2 Query参数
参数	是否必选	参数类型	描述
offset	否	Integer	参数解释：分页查询偏移量。约束限制：不涉及取值范围： [0,1000] 默认取值： 0
limit	否	Integer	参数解释：返回条目数。约束限制：不涉及取值范围： [1,1000] 默认取值： 10
sort_key	否	String	参数解释：排序字段。约束限制：不涉及取值范围：不涉及默认取值：不涉及
sort_dir	否	String	参数解释：排序类型。约束限制：不涉及取值范围： asc: 升序 desc: 降序默认取值： asc

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Workspace-Id	是	String	参数解释：工作空间ID。获取方法请参见获取工作空间ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。约束限制：不涉及取值范围：不涉及默认取值：不涉及

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
count	Integer	参数解释：数量。取值范围：不涉及
page_data	Array of objects	参数解释：实例信息。取值范围：不涉及

请求示例

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

响应示例

状态码：200

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

{
  "count" : 1,
  "page_data" : [ {
    "project_id" : "9c3043ab4dac4055888643b331a0b227",
    "region_id" : "cn-north-7",
    "order_id" : "4e7a0d9517314ebbbe17258a9640c05f",
    "instance_id" : "4e7a0d9517314ebbbe17258a9640c05f",
    "instance_name" : "KooSight-4e7a0d9517314ebbbe17258a9640c05f",
    "instance_spec_code" : "DataArtsInsight.unit.enterprise.user",
    "order_type" : "ON_DEMAND",
    "status" : 2,
    "create_user" : "ei_dlv_l00456193_01",
    "create_date" : 1691142604761,
    "domain_id" : "d22f8acf3c90428fb22606b64dc76823",
    "eps_id" : "0"
  } ]
}