调用CreateDataServiceApi创建数据服务API。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| TenantId |
integer |
否 |
租户 ID。 |
10001 |
| ProjectId |
integer |
是 |
工作空间的 ID。 |
10000 |
| ApiName |
string |
是 |
API 的名称，支持汉字、英文、数字和下划线（_），且只能以英文和汉字开头，4~50 个字符。 |
Test API name |
| GroupId |
string |
是 |
业务流程的 ID。 |
Business process ID |
| ApiMode |
integer |
是 |
API 的类型，可选枚举值包括 0（向导 API）、1（脚本 API）和 2（注册 API）。 |
0 |
| RequestMethod |
integer |
是 |
API 的请求方式，可选枚举值包括 0（GET）、1（POST）、2（PUT）和 3（DELETE）。向导和脚本 API 支持 GET 和 POST。注册 API 支持 GET、POST、PUT 和 DELETE。 |
0 |
| ResponseContentType |
integer |
是 |
API 的返回数据类型，可选枚举值包括 0（JSON）和 1（XML）。向导和脚本 API 支持 JSON，注册 API 支持 JSON 和 XML。 |
0 |
| Timeout |
integer |
是 |
超时时间，单位为毫秒（ms），取值范围为(0, 30000]。 |
10000 |
| VisibleRange |
integer |
是 |
可见范围，可选枚举值包括 0（工作空间）和 1（私有）。 |
0 |
| Protocols |
string |
是 |
API 的协议，可选枚举值包括 0（HTTP）和 1（HTTPS）。支持多个值，多个值之间使用英文逗号（,）分隔。 |
0,1 |
| WizardDetails |
string |
否 |
向导 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"}]} |
| ScriptDetails |
string |
否 |
脚本 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"}]} |
| RegistrationDetails |
string |
否 |
注册 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"} |
| ApiPath |
string |
是 |
API 的路径，支持英文、数字、下划线（_）和连字符（-），且只能以斜线（/）开头，不能超过 200 个字符。 |
/test/1 |
| ApiDescription |
string |
是 |
API 的描述信息。 |
Test API description |
| FolderId |
integer |
否 |
创建 API 的目标文件夹 ID，业务流程下根文件夹 ID 等于 0，用户自建文件夹 ID 大于 0。 |
0 |
| SqlMode |
integer |
否 |
|
0 |
| ResourceGroupId |
integer |
否 |
独享资源组 ID。 |
3242432423 |
| RequestContentType |
integer |
否 |
请求数据类型。
枚举值：
|
0 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Data |
integer |
创建的 API ID。 |
100003 |
| ErrorMessage |
string |
错误信息。 |
The connection does not exist. |
| RequestId |
string |
请求 ID，一次请求的唯一标识。 |
0000-ABCD-EFG**** |
| ErrorCode |
string |
错误码。 |
Invalid.Tenant.ConnectionNotExists |
| Success |
boolean |
调用是否成功。 |
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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 500 | InternalError.System | An internal system error occurred. Try again later. | |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 没有权限，请授权 |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | |
| 429 | Throttling.User | Your request is too frequent. Try again later. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。