文档首页> 交换数据空间 EDS> API参考> API> 实例管理> 查询用户实例列表
更新时间：2024-03-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询用户实例列表

功能介绍

查询用户实例列表，带查询条件，分页接口。

URI

GET /v1/{project_id}/eds/instances/user-instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

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

参数

是否必选

参数类型

描述

name

否

String

实例名称。

参数校验规则：只能包含英文字母、数字、下划线、中文及-，并且只能以中文和英文开头，最小长度1，最大长度100。

resource_spec_code

否

String

EDS实例类型。

枚举值：

  • INSTANCE_FREE，免费版EDS实例
  • INSTANCE_BASIC，基础版EDS实例
  • INSTANCE_PROFESSIONAL，EDS实例专业版

status

否

String

EDS实例状态，支持：NORMAL。

枚举值：

  • CREATING
  • CREATE_FAILED
  • NORMAL
  • FREEZE
  • DELETE

offset

否

Integer

偏移量，表示从此偏移量开始查询，offset大于等于0。

  • 最小值：0
  • 最大值：999999
  • 缺省值：0

limit

否

Integer

每页显示条目数量，最大数量999，超过999后只返回999。

（当前华为云规范防止单页返回过大）。

  • 最小值：1
  • 最大值：999
  • 缺省值：10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

Array of InstanceApiInfo objects

返回数据。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。
表5 InstanceApiInfo

参数

参数类型

描述

id

String

EDS实例ID

name

String

EDS实例名称

description

String

EDS实例描述信息

resource_spec_code

String

EDS资源规格编码

枚举值：

  • INSTANCE_FREE
  • INSTANCE_BASIC
  • INSTANCE_PROFESSIONAL
  • CONNECTOR_FREE
  • CONNECTOR_PRESENTATION
  • CONNECTOR_BASIC
  • STRUCTURED_STORAGE_BASIC
  • UNSTRUCTURED_STORAGE_BASIC

type

String

EDS实例类型

枚举值：

  • INTERNAL
  • STAR_SHAPE
  • OPEN

status

String

EDS实例状态：NORMAL

枚举值：

  • CREATING
  • CREATE_FAILED
  • NORMAL
  • FREEZE
  • DELETE

initialization

Boolean

EDS实例是否已初始化

charging_mode

String

计费模式

枚举值：

  • PERIOD
  • ON_DEMAND
  • FREE_MODE
  • HCS

belong_type

String

EDS实例所属类型：OWNER/GUEST

枚举值：

  • OWNER
  • GUEST
  • STRANGER

enterprise_name

String

企业名称

状态码： 400

表6 响应Body参数

参数

参数类型

描述

data

-

返回null。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

data

-

返回null。

total

Long

总数。

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询用户实例列表。

GET https://{endpoint}/v1/{project_id}/eds/instances/user-instances

响应示例

状态码： 200

OK

  • 资源列表。
    {
  "data" : [ 
{
            "id": "d*********46d2e58",
            "name": "空间实例自测",
            "description": "",
            "resource_spec_code": "instance.basic",
            "type": "OPEN",
            "status": "NORMAL",
            "initialization": true,
            "charging_mode": "PERIOD",
            "belong_type": "OWNER",
            "enterprise_name": "XXX公司"
        },
        {
            "id": "5*********20d925ce5",
            "name": "HC交换空间",
            "description": "HC模式下的交换空间",
            "resource_spec_code": "instance.basic",
            "type": "STAR_SHAPE",
            "status": "NORMAL",
            "initialization": true,
            "charging_mode": "PERIOD",
            "belong_type": "OWNER",
            "enterprise_name": "XXX公司"
        }
 ],
  "total" : 2,
  "error_code" : null,
  "error_msg" : null
}

状态码

状态码

描述

200

successful operation

400

Bad Request

500

Internal Server Error

错误码

请参见错误码。

父主题： 实例管理
分享：

    相关文档

    相关产品