调用GetDataServiceApi查询数据服务API开发态的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetDataServiceApi |
要执行的操作。 |
ApiId | Long | 是 | 10000 |
数据服务API的ID。 |
ProjectId | Long | 是 | 10001 |
工作空间的ID。 |
RegionId | String | 是 | cn-shanghai |
地域ID。 |
TenantId | Long | 是 | 10002 |
租户ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Struct |
返回数据。 |
|
ApiId | Long | 10000 |
数据服务API的ID。 |
ApiMode | Integer | 0 |
API的类型,可选枚举值包括0(向导API)、1(脚本API)和2(注册API)。 |
ApiName | String | 测试API名称 |
API的名称。 |
ApiPath | String | /test/1 |
API的路径。 |
CreatedTime | String | 2020-06-23T00:21:01+0800 |
创建时间。 |
CreatorId | String | 1234567 |
创建人的阿里云ID。 |
Description | String | 测试API描述 |
描述信息。 |
FolderId | Long | 0 |
文件夹ID |
GroupId | String | ab123**** |
分组ID。 |
ModifiedTime | String | 2020-06-23T00:21:01+0800 |
最新修改时间。 |
OperatorId | String | 2345678 |
最新编辑人的阿里云ID。 |
ProjectId | Long | 10001 |
工作空间的ID。 |
Protocols | List | 0 |
API协议,多值列表,可选枚举值包括0(HTTP)和1(HTTPS)。 |
RegistrationDetails | Struct |
注册API的详情,只有注册API返回。 |
|
FailedResultSample | String | {"success": false} |
错误返回示例。 |
RegistrationErrorCodes | Array of RegistrationErrorCode |
注册API的错误码列表。 |
|
ErrorCode | String | 1001 |
错误码。 |
ErrorMessage | String | fail to call |
错误信息。 |
ErrorSolution | String | retry |
错误解决方案。 |
RegistrationRequestParameters | Array of RegistrationRequestParameter |
注册API的请求参数列表。 |
|
ColumnName | String | column1 |
绑定的表字段名称,仅向导模式支持。 |
DefaultValue | String | default1 |
默认值。 |
ExampleValue | String | example1 |
示例值。 |
IsRequiredParameter | Boolean | true |
是否必填。 |
ParameterDataType | Integer | 0 |
数据类型,可选枚举值包括0(STRING)、1(INT)、2(LONG)、3(FLOAT)、4(DOUBLE)和5(BOOLEAN)。 |
ParameterDescription | String | description1 |
描述信息。 |
ParameterName | String | name1 |
参数的名称。 |
ParameterOperator | Integer | 0 |
运算符,可选枚举值有:
向导API支持Equal、Like、In;脚本API支持Equal;注册API支持Equal、Const。 |
ParameterPosition | Integer | 0 |
参数位置,可选枚举值有:
向导和脚本API,只支持Query;注册API,GET、DELETE方法支持Query、Head,PUT、POST方法支持Query、Head、Body。 |
ServiceContentType | Integer | 0 |
API返回数据类型,可选枚举值:
向导和脚本API只支持JSON;注册API支持JSON和XML。 |
ServiceHost | String | http://www.abc.com |
后端服务地址 |
ServicePath | String | /index |
后端服务路径 |
ServiceRequestBodyDescription | String | {"abc":1} |
后端请求body内容描述 |
SuccessfulResultSample | String | {"success": true} |
正常返回示例 |
RequestMethod | Integer | 0 |
API的请求方式,可选枚举值包括0(GET)、1(POST)、2(PUT)和3(DELTE)。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE。 |
ResponseContentType | Integer | 0 |
API的返回数据类型,可选枚举值包括0(JSON)和1(XML)。向导和脚本API支持JSON,注册API支持JSON和XML。 |
ScriptDetails | Struct |
脚本API的详情,只有脚本API返回。 |
|
IsPagedResponse | Boolean | true |
返回是否分页。 |
Script | String | select a from t |
SQL脚本。 |
ScriptConnection | Struct |
脚本API的数据源信息。 |
|
ConnectionId | Long | 123 |
数据源ID。 |
TableName | String | t |
数据源表的名称。 |
ScriptRequestParameters | Array of ScriptRequestParameter |
脚本API的请求参数列表。 |
|
ColumnName | String | column1 |
绑定的表字段名称,仅向导模式支持。 |
DefaultValue | String | default1 |
默认值。 |
ExampleValue | String | example1 |
示例值。 |
IsRequiredParameter | Boolean | true |
是否必填。 |
ParameterDataType | Integer | 0 |
数据类型,可选枚举值包括0(STRING)、1(INT)、2(LONG)、3(FLOAT)、4(DOUBLE)和5(BOOLEAN)。 |
ParameterDescription | String | description1 |
描述信息。 |
ParameterName | String | param1 |
参数的名称。 |
ParameterOperator | Integer | 0 |
运算符,可选枚举值包括0(Equal)、1(Like)、2(Const)和3(In)。向导模式API支持Equal、Like和In,脚本模式API支持Equal,注册API支持Equal和Const。 |
ParameterPosition | Integer | 0 |
参数的位置,可选枚举值包括0(Path)、1(Query)、2(Head)和3(Body)。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head,PUT、POST方法支持Query、Head和Body。 |
ScriptResponseParameters | Array of ScriptResponseParameter |
脚本API的返回参数列表。 |
|
ColumnName | String | column2 |
绑定的表字段名称,仅向导模式支持。 |
ExampleValue | String | example2 |
示例值。 |
ParameterDataType | Integer | 0 |
数据类型,可选枚举值包括0(STRING)、1(INT)、2(LONG)、3(FLOAT)、4(DOUBLE)和5(BOOLEAN)。 |
ParameterDescription | String | description2 |
描述信息。 |
ParameterName | String | param2 |
参数的名称。 |
Status | Integer | 0 |
API的状态,可选枚举值包括0(未发布)和1(已发布)。 |
TenantId | Long | 10002 |
租户ID。 |
Timeout | Integer | 10000 |
超时时间,单位为毫秒(ms)。 |
VisibleRange | Integer | 0 |
可见范围,可选枚举值包括0(工作空间)和1(私有)。 |
WizardDetails | Struct |
向导API详情,只有向导API返回。 |
|
IsPagedResponse | Boolean | true |
返回是否分页。 |
WizardConnection | Struct |
向导API的数据源信息。 |
|
ConnectionId | Long | 123 |
数据源ID。 |
TableName | String | t |
数据源的表名称。 |
WizardRequestParameters | Array of WizardRequestParameter |
向导API的请求参数列表。 |
|
ColumnName | String | column1 |
绑定的表字段名称,仅向导模式支持。 |
DefaultValue | String | default1 |
默认值。 |
ExampleValue | String | example1 |
示例值。 |
IsRequiredParameter | Boolean | true |
是否必填。 |
ParameterDataType | Integer | 0 |
数据类型,可选枚举值包括0(STRING)、1(INT)、2(LONG)、3(FLOAT)、4(DOUBLE)和5(BOOLEAN)。 |
ParameterDescription | String | description1 |
描述信息。 |
ParameterName | String | param1 |
参数的名称。 |
ParameterOperator | Integer | 0 |
运算符,可选枚举值包括0(Equal)、1(Like)、2(Const)和3(In)。向导模式API支持Equal、Like和In,脚本模式API支持Equal,注册API支持Equal和Const。 |
ParameterPosition | Integer | 0 |
参数的位置,可选枚举值包括0(Path)、1(Query)、2(Head)和3(Body)。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head,PUT、POST方法支持Query、Head和Body。 |
WizardResponseParameters | Array of WizardResponseParameter |
向导模式的返回参数列表。 |
|
ColumnName | String | column2 |
绑定的表字段名称,仅向导模式支持。 |
ExampleValue | String | example2 |
示例值。 |
ParameterDataType | Integer | 0 |
数据类型,可选枚举值包括0(STRING)、1(INT)、2(LONG)、3(FLOAT)、4(DOUBLE)和5(BOOLEAN)。 |
ParameterDescription | String | description2 |
描述信息。 |
ParameterName | String | param2 |
参数的名称。 |
ErrorCode | String | 1031203110005 |
错误码。 |
ErrorMessage | String | The specified parameters are invalid. |
错误信息。 |
HttpStatusCode | Integer | 200 |
HTTP状态码。 |
RequestId | String | 0000-ABCD-EFG**** |
请求ID,一次请求的唯一标识。 |
Success | Boolean | true |
调用是否成功。 |
不同类型API的详情信息通过不同字段返回。向导API使用WizardDetails字段,脚本API使用ScriptDetails字段,注册API使用RegistrationDetails字段。
示例
请求示例
http(s)://[Endpoint]/?Action=GetDataServiceApi
&ApiId=10000
&ProjectId=10001
&RegionId=cn-shanghai
&TenantId=10002
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
<Status>0</Status>
<VisibleRange>0</VisibleRange>
<Protocols>0</Protocols>
<WizardDetails>
<Script>select a from t</Script>
<ServiceContentType>0</ServiceContentType>
<ScriptRequestParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</ScriptRequestParameters>
<ScriptRequestParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</ScriptRequestParameters>
<ServicePath>/index</ServicePath>
<RegistrationErrorCodes>
<ErrorCode>1001</ErrorCode>
<ErrorMessage>fail to call</ErrorMessage>
<ErrorSolution>retry</ErrorSolution>
</RegistrationErrorCodes>
<RegistrationErrorCodes>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>name1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</RegistrationErrorCodes>
<WizardResponseParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</WizardResponseParameters>
<WizardResponseParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</WizardResponseParameters>
<ServiceHost>http://www.abc.com</ServiceHost>
<RegistrationRequestParameters>
<ErrorCode>1001</ErrorCode>
<ErrorMessage>fail to call</ErrorMessage>
<ErrorSolution>retry</ErrorSolution>
</RegistrationRequestParameters>
<RegistrationRequestParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>name1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</RegistrationRequestParameters>
<IsPagedResponse>true</IsPagedResponse>
<ServiceRequestBodyDescription>{"abc":1}</ServiceRequestBodyDescription>
<WizardRequestParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</WizardRequestParameters>
<WizardRequestParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</WizardRequestParameters>
<SuccessfulResultSample>{"success": true}</SuccessfulResultSample>
<WizardConnection>
<TableName>t</TableName>
<ConnectionId>123</ConnectionId>
</WizardConnection>
<FailedResultSample>{"success": false}</FailedResultSample>
<ScriptResponseParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</ScriptResponseParameters>
<ScriptResponseParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</ScriptResponseParameters>
<ScriptConnection>
<TableName>t</TableName>
<ConnectionId>123</ConnectionId>
</ScriptConnection>
</WizardDetails>
<CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>
<Description>测试API描述</Description>
<ApiName>测试API名称</ApiName>
<CreatorId>1234567</CreatorId>
<RequestMethod>0</RequestMethod>
<Timeout>10000</Timeout>
<ProjectId>10001</ProjectId>
<ResponseContentType>0</ResponseContentType>
<OperatorId>2345678</OperatorId>
<RegistrationDetails>
<Script>select a from t</Script>
<ServiceContentType>0</ServiceContentType>
<ScriptRequestParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</ScriptRequestParameters>
<ScriptRequestParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</ScriptRequestParameters>
<ServicePath>/index</ServicePath>
<RegistrationErrorCodes>
<ErrorCode>1001</ErrorCode>
<ErrorMessage>fail to call</ErrorMessage>
<ErrorSolution>retry</ErrorSolution>
</RegistrationErrorCodes>
<RegistrationErrorCodes>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>name1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</RegistrationErrorCodes>
<WizardResponseParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</WizardResponseParameters>
<WizardResponseParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</WizardResponseParameters>
<ServiceHost>http://www.abc.com</ServiceHost>
<RegistrationRequestParameters>
<ErrorCode>1001</ErrorCode>
<ErrorMessage>fail to call</ErrorMessage>
<ErrorSolution>retry</ErrorSolution>
</RegistrationRequestParameters>
<RegistrationRequestParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>name1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</RegistrationRequestParameters>
<IsPagedResponse>true</IsPagedResponse>
<ServiceRequestBodyDescription>{"abc":1}</ServiceRequestBodyDescription>
<WizardRequestParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</WizardRequestParameters>
<WizardRequestParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</WizardRequestParameters>
<SuccessfulResultSample>{"success": true}</SuccessfulResultSample>
<WizardConnection>
<TableName>t</TableName>
<ConnectionId>123</ConnectionId>
</WizardConnection>
<FailedResultSample>{"success": false}</FailedResultSample>
<ScriptResponseParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</ScriptResponseParameters>
<ScriptResponseParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</ScriptResponseParameters>
<ScriptConnection>
<TableName>t</TableName>
<ConnectionId>123</ConnectionId>
</ScriptConnection>
</RegistrationDetails>
<GroupId>abcde123456789</GroupId>
<TenantId>10002</TenantId>
<ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>
<ScriptDetails>
<Script>select a from t</Script>
<ServiceContentType>0</ServiceContentType>
<ScriptRequestParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</ScriptRequestParameters>
<ScriptRequestParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</ScriptRequestParameters>
<ServicePath>/index</ServicePath>
<RegistrationErrorCodes>
<ErrorCode>1001</ErrorCode>
<ErrorMessage>fail to call</ErrorMessage>
<ErrorSolution>retry</ErrorSolution>
</RegistrationErrorCodes>
<RegistrationErrorCodes>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>name1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</RegistrationErrorCodes>
<WizardResponseParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</WizardResponseParameters>
<WizardResponseParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</WizardResponseParameters>
<ServiceHost>http://www.abc.com</ServiceHost>
<RegistrationRequestParameters>
<ErrorCode>1001</ErrorCode>
<ErrorMessage>fail to call</ErrorMessage>
<ErrorSolution>retry</ErrorSolution>
</RegistrationRequestParameters>
<RegistrationRequestParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>name1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</RegistrationRequestParameters>
<IsPagedResponse>true</IsPagedResponse>
<ServiceRequestBodyDescription>{"abc":1}</ServiceRequestBodyDescription>
<WizardRequestParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</WizardRequestParameters>
<WizardRequestParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</WizardRequestParameters>
<SuccessfulResultSample>{"success": true}</SuccessfulResultSample>
<WizardConnection>
<TableName>t</TableName>
<ConnectionId>123</ConnectionId>
</WizardConnection>
<FailedResultSample>{"success": false}</FailedResultSample>
<ScriptResponseParameters>
<ColumnName>column1</ColumnName>
<DefaultValue>default1</DefaultValue>
<ExampleValue>example1</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterPosition>0</ParameterPosition>
<ParameterName>param1</ParameterName>
<ParameterOperator>0</ParameterOperator>
<ParameterDescription>description1</ParameterDescription>
<IsRequiredParameter>true</IsRequiredParameter>
</ScriptResponseParameters>
<ScriptResponseParameters>
<ColumnName>column2</ColumnName>
<ExampleValue>example2</ExampleValue>
<ParameterDataType>0</ParameterDataType>
<ParameterName>param2</ParameterName>
<ParameterDescription>description2</ParameterDescription>
</ScriptResponseParameters>
<ScriptConnection>
<TableName>t</TableName>
<ConnectionId>123</ConnectionId>
</ScriptConnection>
</ScriptDetails>
<ApiId>10000</ApiId>
<ApiMode>0</ApiMode>
<ApiPath>/test/1</ApiPath>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>
JSON
格式
{
"RequestId": "0000-ABCD-EFG****",
"HttpStatusCode": 200,
"Data": {
"Status": 0,
"VisibleRange": 0,
"Protocols": 0,
"WizardDetails": {
"Script": "select a from t",
"ServiceContentType": 0,
"ScriptRequestParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"ServicePath": "/index",
"RegistrationErrorCodes": [
{
"ErrorCode": 1001,
"ErrorMessage": "fail to call",
"ErrorSolution": "retry"
},
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "name1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
}
],
"WizardResponseParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"ServiceHost": "http://www.abc.com",
"RegistrationRequestParameters": [
{
"ErrorCode": 1001,
"ErrorMessage": "fail to call",
"ErrorSolution": "retry"
},
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "name1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
}
],
"IsPagedResponse": true,
"ServiceRequestBodyDescription": "{\"abc\":1}",
"WizardRequestParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"SuccessfulResultSample": "{\"success\": true}",
"WizardConnection": {
"TableName": "t",
"ConnectionId": 123
},
"FailedResultSample": "{\"success\": false}",
"ScriptResponseParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"ScriptConnection": {
"TableName": "t",
"ConnectionId": 123
}
},
"CreatedTime": "2020-06-23T00:21:01+0800",
"Description": "测试API描述",
"ApiName": "测试API名称",
"CreatorId": 1234567,
"RequestMethod": 0,
"Timeout": 10000,
"ProjectId": 10001,
"ResponseContentType": 0,
"OperatorId": 2345678,
"RegistrationDetails": {
"Script": "select a from t",
"ServiceContentType": 0,
"ScriptRequestParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"ServicePath": "/index",
"RegistrationErrorCodes": [
{
"ErrorCode": 1001,
"ErrorMessage": "fail to call",
"ErrorSolution": "retry"
},
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "name1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
}
],
"WizardResponseParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"ServiceHost": "http://www.abc.com",
"RegistrationRequestParameters": [
{
"ErrorCode": 1001,
"ErrorMessage": "fail to call",
"ErrorSolution": "retry"
},
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "name1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
}
],
"IsPagedResponse": true,
"ServiceRequestBodyDescription": "{\"abc\":1}",
"WizardRequestParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"SuccessfulResultSample": "{\"success\": true}",
"WizardConnection": {
"TableName": "t",
"ConnectionId": 123
},
"FailedResultSample": "{\"success\": false}",
"ScriptResponseParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"ScriptConnection": {
"TableName": "t",
"ConnectionId": 123
}
},
"GroupId": "abcde123456789",
"TenantId": 10002,
"ModifiedTime": "2020-06-23T00:21:01+0800",
"ScriptDetails": {
"Script": "select a from t",
"ServiceContentType": 0,
"ScriptRequestParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"ServicePath": "/index",
"RegistrationErrorCodes": [
{
"ErrorCode": 1001,
"ErrorMessage": "fail to call",
"ErrorSolution": "retry"
},
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "name1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
}
],
"WizardResponseParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"ServiceHost": "http://www.abc.com",
"RegistrationRequestParameters": [
{
"ErrorCode": 1001,
"ErrorMessage": "fail to call",
"ErrorSolution": "retry"
},
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "name1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
}
],
"IsPagedResponse": true,
"ServiceRequestBodyDescription": "{\"abc\":1}",
"WizardRequestParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"SuccessfulResultSample": "{\"success\": true}",
"WizardConnection": {
"TableName": "t",
"ConnectionId": 123
},
"FailedResultSample": "{\"success\": false}",
"ScriptResponseParameters": [
{
"ColumnName": "column1",
"DefaultValue": "default1",
"ExampleValue": "example1",
"ParameterDataType": 0,
"ParameterPosition": 0,
"ParameterName": "param1",
"ParameterOperator": 0,
"ParameterDescription": "description1",
"IsRequiredParameter": true
},
{
"ColumnName": "column2",
"ExampleValue": "example2",
"ParameterDataType": 0,
"ParameterName": "param2",
"ParameterDescription": "description2"
}
],
"ScriptConnection": {
"TableName": "t",
"ConnectionId": 123
}
},
"ApiId": 10000,
"ApiMode": 0,
"ApiPath": "/test/1"
},
"ErrorCode": 1031203110005,
"ErrorMessage": "The specified parameters are invalid.",
"Success": true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | 对该资源的请求已超过您的可用上限。 |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 您被限制访问,请开通DataWorks企业版或旗舰版。 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交