文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据服务API/ API管理接口/ 全量导出包含API的EXCEL压缩文件
更新时间：2024-07-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

全量导出包含API的EXCEL压缩文件

功能介绍

全量导出包含API的EXCEL压缩文件。

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/service/export/zip

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参见项目ID和账号ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token，使用Token认证时必选。通过调用IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

workspace

是

String

工作空间ID，获取方法请参见实例ID和工作空间ID。

Dlm-Type

否

String

数据服务的版本类型，指定SHARED共享版或EXCLUSIVE专享版。

Content-Type

是

String

消息体的类型（格式），有Body体的情况下必选，没有Body体无需填写。如果请求消息体中含有中文字符，则需要通过charset=utf8指定中文字符集，例如取值为：application/json;charset=utf8。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

API名称。

create_user

否

String

API创建人名称。

description

否

String

API描述。

tags

否

Array of strings

API标签列表。

table_name

否

String

API所使用到的数据库表名。

publish_status_type

否

String

API发布状态。

枚举值：

  • PUBLISHED: 已发布

  • NOT_PUBLISHED: 未发布

api_specific_type_str

否

String

API取数方式。

枚举值：

  • API_SPECIFIC_TYPE_CONFIGURATION: 配置方式

  • API_SPECIFIC_TYPE_SCRIPT: 脚本方式

  • API_SPECIFIC_TYPE_MYBATIS: MyBatis方式

  • API_SPECIFIC_TYPE_GROOVY: Groovy方式

start_time

否

String

API创建开始时间。

end_time

否

String

API创建结束时间。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

-

File

导出包含API的EXCEL文件，会导出多个EXCEL文件，每个EXCEL文件最多200个API，多个EXCEL文件会打包到ZIP文件返回。

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

全量导出包含API的EXCEL压缩文件。

/v1/0833a5737480d53b2f250010d01a7b88/service/export/zip

{
  "name" : "name",
  "create_user" : "dev",
  "api_specific_type_str" : "API_SPECIFIC_TYPE_CONFIGURATION",
  "start_time" : "2024-02-29T16:00:00.000Z",
  "end_time" : "2024-07-02T15:59:59.998Z",
  "tags" : [ "111", "22", "33" ]
}

响应示例

状态码： 200

全量导出成功。

"xxx.zip"

状态码

状态码

描述

200

全量导出成功。

400

BadRequest。
父主题： API管理接口

相关文档