备案控制台
文档
产品文档
输入文档关键字查找
首页 大数据开发治理平台 DataWorks 开发参考 API参考 API目录 数据服务 CreateDataServiceApi - 创建数据服务API

CreateDataServiceApi - 创建数据服务API

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

调用CreateDataServiceApi创建数据服务API。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
dataworks:*Write
  • 全部资源
    *
    无
无

请求参数

名称类型必填描述示例值
TenantIdlong否

租户 ID。

10001
ProjectIdlong是

工作空间的 ID。

10000
ApiNamestring是

API 的名称，支持汉字、英文、数字和下划线（_），且只能以英文和汉字开头，4~50 个字符。

测试API名称
GroupIdstring是

业务流程的 ID。

业务流程ID
ApiModeinteger是

API 的类型，可选枚举值包括 0（向导 API）、1（脚本 API）和 2（注册 API）。

0
RequestMethodinteger是

API 的请求方式，可选枚举值包括 0（GET）、1（POST）、2（PUT）和 3（DELETE）。向导和脚本 API 支持 GET 和 POST。注册 API 支持 GET、POST、PUT 和 DELETE。

0
ResponseContentTypeinteger是

API 的返回数据类型，可选枚举值包括 0（JSON）和 1（XML）。向导和脚本 API 支持 JSON，注册 API 支持 JSON 和 XML。

0
Timeoutinteger是

超时时间，单位为毫秒（ms），取值范围为(0, 30000]。

10000
VisibleRangeinteger是

可见范围，可选枚举值包括 0（工作空间）和 1（私有）。

0
Protocolsstring是

API 的协议，可选枚举值包括 0（HTTP）和 1（HTTPS）。支持多个值，多个值之间使用英文逗号（,）分隔。

0,1
WizardDetailsstring否

向导 API 的详情，请参见 GetDataServiceApi 接口 wizardDetails 字段的 JSON String。

{"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}
ScriptDetailsstring否

脚本 API 的详情，请参见 GetDataServiceApi 接口 scriptDetails 字段的 JSON String。

{"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}
RegistrationDetailsstring否

注册 API 的详情，请参见 GetDataServiceApi 接口 registrationDetails 字段的 JSON String。

{"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}
ApiPathstring是

API 的路径，支持英文、数字、下划线（_）和连字符（-），且只能以斜线（/）开头，不能超过 200 个字符。

/test/1
ApiDescriptionstring是

API 的描述信息。

测试API描述
FolderIdlong否

创建 API 的目标文件夹 ID，业务流程下根文件夹 ID 等于 0，用户自建文件夹 ID 大于 0。

0
SqlModelong否

  • 0-基础模式。

  • 1-mybatis

0
ResourceGroupIdlong否

独享资源组 ID。

3242432423
RequestContentTypeinteger否

请求数据类型。

  • 0：xml

  • 1：json

  • 2：form

0

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码。

200
Datalong

创建的 API ID。

100003
ErrorMessagestring

错误信息。

The connection does not exist.
RequestIdstring

请求 ID，一次请求的唯一标识。

0000-ABCD-EFG****
ErrorCodestring

错误码。

Invalid.Tenant.ConnectionNotExists
Successboolean

调用是否成功。

true

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Data": 100003,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限，请授权
429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙，请稍后再试。
429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁，请尝试放缓请求速度。
500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误，请稍后再试。
500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误，请稍后再试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-10OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：403
    删除错误码：429
    删除错误码：500
2023-03-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：403
    删除错误码：429
    删除错误码：500
入参OpenAPI 入参发生变更。
    新增入参：RequestContentType
2023-03-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：403
    删除错误码：429
    删除错误码：500
入参OpenAPI 入参发生变更。
    新增入参：SqlMode
    新增入参：ResourceGroupId
上一篇：数据服务下一篇：PublishDataServiceApi - 发布数据服务API
文档推荐
  • 本页导读 （1）