新增应用 - addApplication

功能介绍

新增应用。

授权信息

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

URI

POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。获取方法请参考获取项目ID。
instance_id	是	String	实例ID，开通的交换数据平台实例ID。获取方法请参考获取实例ID。
connector_id	是	String	连接器ID，指定交换数据平台下连接器的ID。获取方法请参考获取连接器ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token，通过调用IAM服务“获取用户Token”接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
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	应用名称。
temp_id	是	String	应用模板ID。
description	否	String	应用描述。
icon	否	String	应用图标。
connection	是	DataSourceConnect object	数据源连接信息。

表4 DataSourceConnect
参数	是否必选	参数类型	描述
datasource_type	否	String	数据源类型。枚举值： OBS
connection	否	DataSourceConnection object	数据源连接信息。

表5 DataSourceConnection
参数	是否必选	参数类型	描述
obs_connection	否	ObsConnection object	OBS数据源连接信息。

表6 ObsConnection
参数	是否必选	参数类型	描述
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，只能包含英文字母、数字、下划线、中文、/、\及-。

响应参数

状态码： 200

表7 响应Body参数
参数	参数类型	描述
data	AppInfo object	新增应用返回体。
total	Long	总数。
error_code	String	错误码。
error_msg	String	错误描述。

表8 AppInfo
参数	参数类型	描述
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	创建时间。

表9 DataSourceConnect
参数	参数类型	描述
datasource_type	String	数据源类型。枚举值： OBS
connection	DataSourceConnection object	数据源连接信息。

**表10** DataSourceConnection
参数	参数类型	描述
obs_connection	ObsConnection object	OBS数据源连接信息。

**表11** ObsConnection
参数	参数类型	描述
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

**表12** 响应Body参数
参数	参数类型	描述
data	Object	返回数据。
total	Long	总数。
error_code	String	错误码。
error_msg	String	错误描述。

状态码： 500

**表13** 响应Body参数
参数	参数类型	描述
data	Object	返回数据。
total	Long	总数。
error_code	String	错误码。
error_msg	String	错误描述。

请求示例

新增应用。

POST https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications

{
  "type" : "UNSTRUCTURED",
  "name" : "OBS-APP-TEST",
  "temp_id" : "335ac118-758e-4324-9d41-************",
  "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN***          // ***代表省略的图标编码",
  "description" : "test",
  "connection" : {
    "datasource_type" : "OBS",
    "connection" : {
      "obs_connection" : {
        "endpoint" : "obs.************.huawei.com",
        "bucket_name" : "obs-***",
        "access_key" : "QA**************",
        "secret_key" : "8X**************",
        "path" : "obs-test/folder1"
      }
    }
  }
}

响应示例

状态码： 200

新增应用返回体。

{
  "data" : {
    "type" : "UNSTRUCTURED",
    "name" : "OBS-APP-TEST",
    "id" : "22c59dd8-12ef-4ead-94ff-************",
    "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-12-05T18:27:52Z"
  },
  "total" : 1,
  "error_code" : null,
  "error_msg" : null
}