# 查看实例化应用列表 - listApplications #### 功能介绍 查看实例化应用列表。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-eds/eds_06_0017.html)。 #### URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 获取方法请参考[获取项目ID](https://support.huaweicloud.com/api-eds/eds_06_0023.html)。 | | instance_id | 是 | String | 实例ID，开通的交换数据平台实例ID。 获取方法请参考[获取实例ID](https://support.huaweicloud.com/api-eds/eds_06_0025.html)。 | | connector_id | 是 | String | 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考[获取连接器ID](https://support.huaweicloud.com/api-eds/eds_06_0026.html)。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | offset | 否 | Integer | 偏移量，表示从此偏移量开始查询，offset大于等于0。 - 最小值：0 - 最大值：999999 - 缺省值：0 | | limit | 否 | Integer | 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 - 最小值：1 - 最大值：999 - 缺省值：10 | | app_name | 否 | String | 实例化APP名称。 | | ids | 否 | Array | 实例化APP ID。 | | operations | 否 | Array | 执行动作过滤。 枚举值： - **VIEW** - **PROCESS** - **DOWNLOAD** | | status | 否 | Array | 状态： - NORMAL：正常使用状态 - DISABLE：停用状态，不再分配给新的eds实例 枚举值： - **NORMAL** - **DISABLE** | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token，通过调用IAM服务"获取用户Token"接口获取（响应消息头中X-Subject-Token的值）。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | Array of [AppInfo] objects | 返回数据。 | | total | Long | 总数。 | | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | 表5AppInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 实例化的应用类型： - STRUCTURED：支持jdbc、csv下载 - TRUSTED_ENV：支持可信环境下载 - LOCAL_DOWN：支持本地下载 - LUCKY_EXCEL：支持excel本地预览 - UNSTRUCTURED：支持obs、sftp、ftp下载 - PDF_JS：支持pdf本地预览 - STRUCTURED_VIEW：支持csv jdbc本地预览 - WPS：wps应用 - IMAGE_VIEWER：本地图片查看 枚举值： - **STRUCTURED** - **TRUSTED_ENV** - **LOCAL_DOWN** - **LUCKY_EXCEL** - **UNSTRUCTURED** - **PDF_JS** - **STRUCTURED_VIEW** - **WPS** - **IMAGE_VIEWER** | | name | String | 应用名称。 | | id | String | 应用ID。 | | temp_id | String | 应用模板ID。 | | temp_name | String | 应用模板名称。 | | natives | Boolean | 是否内置应用 - true：内置 - false：自创 | | operation | Array of strings | 应用操作。 枚举值： - **VIEW** - **PROCESS** - **DOWNLOAD** | | description | String | 应用描述。 | | icon | String | 应用图标。 | | connection | [DataSourceConnect] object | 应用连接信息。 | | create_user_id | String | 创建人ID。 | | create_user_name | String | 创建人名称。 | | create_date | String | 创建时间。 | 表6DataSourceConnect | 参数 | 参数类型 | 描述 | |:---|:---|:---| | datasource_type | String | 数据源类型。 枚举值： - **MRS_HIVE** - **ORACLE** - **MYSQL** - **DWS** - **GAUSS_DB** - **FTP** - **SFTP** - **OBS** - **WPS** - **API** | | connection | [DataSourceConnection] object | 数据源连接信息。 | 表7DataSourceConnection | 参数 | 参数类型 | 描述 | |:---|:---|:---| | obs_connection | [ObsConnection] object | OBS数据源连接信息。 | 表8ObsConnection | 参数 | 参数类型 | 描述 | |:---|:---|:---| | endpoint | String | OBS访问地址。 参数校验规则：最小长度1，最大长度1000，匹配域名正则表达式。 | | bucket_name | String | OBS名称。 参数校验规则：最小长度1，最大长度100，匹配字母、数字、下划线、.及-。 | | access_key | String | OBS永久访问密钥。 参数校验规则：最大长度1024。 | | secret_key | String | OBS永久密钥。 参数校验规则：最大长度1024。 | | path | String | OBS访问路径。 参数校验规则：最小长度1，最大长度100，只能包含英文字母、数字、下划线、中文、/、\\及-。 | **状态码： 400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | Object | 返回数据。 | | total | Long | 总数。 | | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | **状态码： 500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | Object | 返回数据。 | | total | Long | 总数。 | | error_code | String | 错误码。 | | error_msg | String | 错误描述。 | #### 请求示例 查看实例化应用列表。 ``` GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications?offset=0&limit=10&operations=DOWNLOAD ``` #### 响应示例 **状态码： 200** OK - 查看实例化应用列表。 ``` { "data" : [ { "type" : "UNSTRUCTURED", "name" : "OBS4", "id" : "70d5c8d0-fe76-4cf0-9d30-***********", "temp_id" : "335ac118-758e-4324-9d41-***********", "temp_name" : "文档下载", "natives" : false, "operation" : [ "DOWNLOAD" ], "description" : "abc", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "connection" : { "datasource_type" : "OBS", "connection" : null }, "create_user_id" : "test-***********", "create_user_name" : "test-***********", "create_date" : "2023-11-21T16:50:53Z" } ], "total" : 1, "error_code" : null, "error_msg" : null } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-eds/ErrorCode.html)。