# 查询用户实例列表 - ListUserInstances #### 功能介绍 查询用户实例列表。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eds/eds_06_0017.html)。 #### URI GET /v1/{project_id}/eds/instances/user-instances 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-eds/eds_06_0023.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | 实例名称。 参数校验规则：只能包含英文字母、数字、下划线、中文及-，并且只能以中文和英文开头，最小长度1，最大长度100。 | | resource_spec_code | 否 | String | EDS实例类型。 - INSTANCE_FREE：免费版EDS实例 - INSTANCE_BASIC：基础版EDS实例 - INSTANCE_PROFESSIONAL：EDS实例专业版 枚举值： - **INSTANCE_FREE** - **INSTANCE_BASIC** - **INSTANCE_PROFESSIONAL** | | belong_type | 否 | Array | 归属类型。 - OWNER：实例的所有者 - GUEST：实例的参与者 枚举值： - **OWNER** - **GUEST** | | status | 否 | String | EDS实例状态。 枚举值： - **CREATING** - **CREATE_FAILED** - **NORMAL** - **FREEZE** | | 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 | 错误描述。 | 表5InstanceApiInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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实例状态。 枚举值： - **CREATING** - **CREATE_FAILED** - **NORMAL** - **FREEZE** | | initialization | Boolean | EDS实例是否已初始化。 | | charging_mode | String | 计费模式。 枚举值： - **PERIOD** - **ON_DEMAND** - **FREE_MODE** - **HCS** | | belong_type | String | EDS实例所属类型：OWNER/GUEST。 枚举值： - **OWNER** - **GUEST** | | enterprise_name | String | 企业名称。 | | administrator_user_id | String | 管理员用户ID。 | **状态码： 400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | Object | 返回数据。 | | total | Long | 总数。 | | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码： 500** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | Object | 返回数据。 | | total | Long | 总数。 | | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 查看实例化应用列表。 ``` GET https://{endpoint}/v1/{project_id}/eds/instances/user-instances ``` #### 响应示例 **状态码： 200** OK - 查询用户实例列表。 ``` { "data" : [ { "id" : "b40b0d94-3201-4687-93aa-************", "name" : "连接器A", "description" : "连接器A", "resource_spec_code" : "instance.basic", "type" : "OPEN", "status" : "NORMAL", "initialization" : true, "charging_mode" : "PERIOD", "belong_type" : "OWNER", "enterprise_name" : "XXX公司", "administrator_user_id" : "6c4027c7536040619226f2**********" }, { "id" : "c1bf9bd7-52fc-435b-ae55-************", "name" : "连接器B", "description" : "连接器B", "resource_spec_code" : "instance.basic", "type" : "OPEN", "status" : "NORMAL", "initialization" : true, "charging_mode" : "PERIOD", "belong_type" : "OWNER", "enterprise_name" : "XXX公司", "administrator_user_id" : "6c4027c7536040619226f2**********" } ], "total" : 2, "error_code" : null, "error_msg" : null } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eds/ErrorCode.html)。