调用GetDataServiceApi查询数据服务API开发态的详情_大数据开发治理平台 DataWorks-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	GetDataServiceApi	系统规定参数。取值：GetDataServiceApi。
TenantId	Long	是	10002	租户ID。
ProjectId	Long	是	10001	工作空间的ID。
ApiId	Long	是	10000	数据服务API的ID。

返回数据

名称	类型	示例值	描述
HttpStatusCode	Integer	200	HTTP状态码。
RequestId	String	0000-ABCD-EFG****	请求ID，一次请求的唯一标识。
ErrorMessage	String	The specified parameters are invalid.	错误信息。
Success	Boolean	true	调用是否成功。
ErrorCode	String	1031203110005	错误码。
Data	Object		返回数据。
Timeout	Integer	10000	超时时间，单位为毫秒（ms）。
Status	Integer	0	API的状态，可选枚举值包括0（未发布）和1（已发布）。
ApiId	Long	10000	数据服务API的ID。
ApiMode	Integer	0	API的类型，可选枚举值包括0（向导API）、1（脚本API）和2（注册API）。
ProjectId	Long	10001	工作空间的ID。
ResponseContentType	Integer	0	API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML。
CreatorId	String	1234567	创建人的阿里云ID。
VisibleRange	Integer	0	可见范围，可选枚举值包括0（工作空间）和1（私有）。
ModifiedTime	String	2020-06-23T00:21:01+0800	最新修改时间。
OperatorId	String	2345678	最新编辑人的阿里云ID。
GroupId	String	ab123****	分组ID。
Description	String	测试API描述	描述信息。
FolderId	Long	0	文件夹ID
RequestMethod	Integer	0	API的请求方式，可选枚举值包括0（GET）、1（POST）、2（PUT）和3（DELETE）。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE。
CreatedTime	String	2020-06-23T00:21:01+0800	创建时间。
ApiName	String	测试API名称	API的名称。
TenantId	Long	10002	租户ID。
ApiPath	String	/test/1	API的路径。
Protocols	Array of Integer	0	API协议，多值列表，可选枚举值包括0（HTTP）和1（HTTPS）。
RegistrationDetails	Object		注册API的详情，只有注册API返回。
ServiceHost	String	http://example.aliyundoc.com	后端服务地址
ServiceContentType	Integer	0	API返回数据类型，可选枚举值： 0：JSON 1：XML 向导和脚本API只支持JSON；注册API支持JSON和XML。
ServicePath	String	/index	后端服务路径
SuccessfulResultSample	String	{"success": true}	正常返回示例
FailedResultSample	String	{"success": false}	错误返回示例。
ServiceRequestBodyDescription	String	{"abc":1}	后端请求body内容描述
RegistrationErrorCodes	Array of RegistrationErrorCode		注册API的错误码列表。
ErrorMessage	String	fail to call	错误信息。
ErrorCode	String	1001	错误码。
ErrorSolution	String	retry	错误解决方案。
RegistrationRequestParameters	Array of RegistrationRequestParameter		注册API的请求参数列表。
ColumnName	String	column1	绑定的表字段名称，仅向导模式支持。
ParameterName	String	name1	参数的名称。
ParameterPosition	Integer	0	参数位置，可选枚举值有： 0：Path 1：Query 2：Head 3：Body 向导和脚本API，只支持Query；注册API，GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head、Body。
ParameterDescription	String	description1	描述信息。
DefaultValue	String	default1	默认值。
ParameterOperator	Integer	0	运算符，可选枚举值有： 0：Equal 1：Like 2：Const 3：In 向导API支持Equal、Like、In；脚本API支持Equal；注册API支持Equal、Const。
ParameterDataType	Integer	0	数据类型，可选枚举值： 0：String 1：Int 2：Long 3：Float 4：Double 5：Boolean 6：StringList 7：IntList 8：LongList 9：FloatList 10：DoubleList 11：BooleanList
ExampleValue	String	example1	示例值。
IsRequiredParameter	Boolean	true	是否必填。
ScriptDetails	Object		脚本API的详情，只有脚本API返回。
Script	String	select a from t	SQL脚本。
IsPagedResponse	Boolean	true	返回是否分页。
ScriptRequestParameters	Array of ScriptRequestParameter		脚本API的请求参数列表。
ColumnName	String	column1	绑定的表字段名称，仅向导模式支持。
ParameterName	String	param1	参数的名称。
ParameterPosition	Integer	0	参数的位置，可选枚举值包括0（Path）、1（Query）、2（Head）和3（Body）。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head和Body。
ParameterDescription	String	description1	描述信息。
DefaultValue	String	default1	默认值。
ParameterOperator	Integer	0	运算符，可选枚举值包括0（Equal）、1（Like）、2（Const）和3（In）。向导模式API支持Equal、Like和In，脚本模式API支持Equal，注册API支持Equal和Const。
ParameterDataType	Integer	0	数据类型，可选枚举值： 0：String 1：Int 2：Long 3：Float 4：Double 5：Boolean 6：StringList 7：IntList 8：LongList 9：FloatList 10：DoubleList 11：BooleanList
ExampleValue	String	example1	示例值。
IsRequiredParameter	Boolean	true	是否必填。
ScriptResponseParameters	Array of ScriptResponseParameter		脚本API的返回参数列表。
ParameterDescription	String	description2	描述信息。
ColumnName	String	column2	绑定的表字段名称，仅向导模式支持。
ParameterName	String	param2	参数的名称。
ParameterDataType	Integer	0	数据类型，可选枚举值： 0：String 1：Int 2：Long 3：Float 4：Double 5：Boolean 6：StringList 7：IntList 8：LongList 9：FloatList 10：DoubleList 11：BooleanList
ExampleValue	String	example2	示例值。
ScriptConnection	Object		脚本API的数据源信息。
TableName	String	t	数据源表的名称。
ConnectionId	Long	123	数据源ID。
WizardDetails	Object		向导API详情，只有向导API返回。
IsPagedResponse	Boolean	true	返回是否分页。
WizardRequestParameters	Array of WizardRequestParameter		向导API的请求参数列表。
ColumnName	String	column1	绑定的表字段名称，仅向导模式支持。
ParameterName	String	param1	参数的名称。
ParameterPosition	Integer	0	参数的位置，可选枚举值包括0（Path）、1（Query）、2（Head）和3（Body）。向导和脚本API仅支持Query。注册API中的GET、DELETE方法支持Query、Head，PUT、POST方法支持Query、Head和Body。
ParameterDescription	String	description1	描述信息。
DefaultValue	String	default1	默认值。
ParameterOperator	Integer	0	运算符，可选枚举值包括0（Equal）、1（Like）、2（Const）和3（In）。向导模式API支持Equal、Like和In，脚本模式API支持Equal，注册API支持Equal和Const。
ParameterDataType	Integer	0	数据类型，可选枚举值： 0：String 1：Int 2：Long 3：Float 4：Double 5：Boolean 6：StringList 7：IntList 8：LongList 9：FloatList 10：DoubleList 11：BooleanList
ExampleValue	String	example1	示例值。
IsRequiredParameter	Boolean	true	是否必填。
WizardResponseParameters	Array of WizardResponseParameter		向导模式的返回参数列表。
ParameterDescription	String	description2	描述信息。
ColumnName	String	column2	绑定的表字段名称，仅向导模式支持。
ParameterName	String	param2	参数的名称。
ParameterDataType	Integer	0	数据类型，可选枚举值： 0：String 1：Int 2：Long 3：Float 4：Double 5：Boolean 6：StringList 7：IntList 8：LongList 9：FloatList 10：DoubleList 11：BooleanList
ExampleValue	String	example2	示例值。
WizardConnection	Object		向导API的数据源信息。
TableName	String	t	数据源的表名称。
ConnectionId	Long	123	数据源ID。

不同类型API的详情信息通过不同字段返回。向导API使用WizardDetails字段，脚本API使用ScriptDetails字段，注册API使用RegistrationDetails字段。

示例

请求示例

http(s)://[Endpoint]/?Action=GetDataServiceApi
&TenantId=10002
&ProjectId=10001
&ApiId=10000
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetDataServiceApiResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The specified parameters are invalid.</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>1031203110005</ErrorCode>
    <Data>
        <Timeout>10000</Timeout>
        <Status>0</Status>
        <ApiId>10000</ApiId>
        <ApiMode>0</ApiMode>
        <ProjectId>10001</ProjectId>
        <ResponseContentType>0</ResponseContentType>
        <CreatorId>1234567</CreatorId>
        <VisibleRange>0</VisibleRange>
        <ModifiedTime>2020-06-23T00:21:01+0800</ModifiedTime>
        <OperatorId>2345678</OperatorId>
        <GroupId>ab123****</GroupId>
        <Description>测试API描述</Description>
        <FolderId>0</FolderId>
        <RequestMethod>0</RequestMethod>
        <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>
        <ApiName>测试API名称</ApiName>
        <TenantId>10002</TenantId>
        <ApiPath>/test/1</ApiPath>
        <Protocols>0</Protocols>
        <RegistrationDetails>
            <ServiceHost>http://example.aliyundoc.com</ServiceHost>
            <ServiceContentType>0</ServiceContentType>
            <ServicePath>/index</ServicePath>
            <SuccessfulResultSample>{"success": true}</SuccessfulResultSample>
            <FailedResultSample>{"success": false}</FailedResultSample>
            <ServiceRequestBodyDescription>{"abc":1}</ServiceRequestBodyDescription>
            <RegistrationErrorCodes>
                <ErrorMessage>fail to call</ErrorMessage>
                <ErrorCode>1001</ErrorCode>
                <ErrorSolution>retry</ErrorSolution>
            </RegistrationErrorCodes>
            <RegistrationRequestParameters>
                <ColumnName>column1</ColumnName>
                <ParameterName>name1</ParameterName>
                <ParameterPosition>0</ParameterPosition>
                <ParameterDescription>description1</ParameterDescription>
                <DefaultValue>default1</DefaultValue>
                <ParameterOperator>0</ParameterOperator>
                <ParameterDataType>0</ParameterDataType>
                <ExampleValue>example1</ExampleValue>
                <IsRequiredParameter>true</IsRequiredParameter>
            </RegistrationRequestParameters>
        </RegistrationDetails>
        <ScriptDetails>
            <Script>select a from t</Script>
            <IsPagedResponse>true</IsPagedResponse>
            <ScriptRequestParameters>
                <ColumnName>column1</ColumnName>
                <ParameterName>param1</ParameterName>
                <ParameterPosition>0</ParameterPosition>
                <ParameterDescription>description1</ParameterDescription>
                <DefaultValue>default1</DefaultValue>
                <ParameterOperator>0</ParameterOperator>
                <ParameterDataType>0</ParameterDataType>
                <ExampleValue>example1</ExampleValue>
                <IsRequiredParameter>true</IsRequiredParameter>
            </ScriptRequestParameters>
            <ScriptResponseParameters>
                <ParameterDescription>description2</ParameterDescription>
                <ColumnName>column2</ColumnName>
                <ParameterName>param2</ParameterName>
                <ParameterDataType>0</ParameterDataType>
                <ExampleValue>example2</ExampleValue>
            </ScriptResponseParameters>
            <ScriptConnection>
                <TableName>t</TableName>
                <ConnectionId>123</ConnectionId>
            </ScriptConnection>
        </ScriptDetails>
        <WizardDetails>
            <IsPagedResponse>true</IsPagedResponse>
            <WizardRequestParameters>
                <ColumnName>column1</ColumnName>
                <ParameterName>param1</ParameterName>
                <ParameterPosition>0</ParameterPosition>
                <ParameterDescription>description1</ParameterDescription>
                <DefaultValue>default1</DefaultValue>
                <ParameterOperator>0</ParameterOperator>
                <ParameterDataType>0</ParameterDataType>
                <ExampleValue>example1</ExampleValue>
                <IsRequiredParameter>true</IsRequiredParameter>
            </WizardRequestParameters>
            <WizardResponseParameters>
                <ParameterDescription>description2</ParameterDescription>
                <ColumnName>column2</ColumnName>
                <ParameterName>param2</ParameterName>
                <ParameterDataType>0</ParameterDataType>
                <ExampleValue>example2</ExampleValue>
            </WizardResponseParameters>
            <WizardConnection>
                <TableName>t</TableName>
                <ConnectionId>123</ConnectionId>
            </WizardConnection>
        </WizardDetails>
    </Data>
</GetDataServiceApiResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorMessage" : "The specified parameters are invalid.",
  "Success" : true,
  "ErrorCode" : 1031203110005,
  "Data" : {
    "Timeout" : 10000,
    "Status" : 0,
    "ApiId" : 10000,
    "ApiMode" : 0,
    "ProjectId" : 10001,
    "ResponseContentType" : 0,
    "CreatorId" : 1234567,
    "VisibleRange" : 0,
    "ModifiedTime" : "2020-06-23T00:21:01+0800",
    "OperatorId" : 2345678,
    "GroupId" : "ab123****",
    "Description" : "测试API描述",
    "FolderId" : 0,
    "RequestMethod" : 0,
    "CreatedTime" : "2020-06-23T00:21:01+0800",
    "ApiName" : "测试API名称",
    "TenantId" : 10002,
    "ApiPath" : "/test/1",
    "Protocols" : 0,
    "RegistrationDetails" : {
      "ServiceHost" : "http://example.aliyundoc.com",
      "ServiceContentType" : 0,
      "ServicePath" : "/index",
      "SuccessfulResultSample" : "{\"success\": true}",
      "FailedResultSample" : "{\"success\": false}",
      "ServiceRequestBodyDescription" : "{\"abc\":1}",
      "RegistrationErrorCodes" : {
        "ErrorMessage" : "fail to call",
        "ErrorCode" : 1001,
        "ErrorSolution" : "retry"
      },
      "RegistrationRequestParameters" : {
        "ColumnName" : "column1",
        "ParameterName" : "name1",
        "ParameterPosition" : 0,
        "ParameterDescription" : "description1",
        "DefaultValue" : "default1",
        "ParameterOperator" : 0,
        "ParameterDataType" : 0,
        "ExampleValue" : "example1",
        "IsRequiredParameter" : true
      }
    },
    "ScriptDetails" : {
      "Script" : "select a from t",
      "IsPagedResponse" : true,
      "ScriptRequestParameters" : {
        "ColumnName" : "column1",
        "ParameterName" : "param1",
        "ParameterPosition" : 0,
        "ParameterDescription" : "description1",
        "DefaultValue" : "default1",
        "ParameterOperator" : 0,
        "ParameterDataType" : 0,
        "ExampleValue" : "example1",
        "IsRequiredParameter" : true
      },
      "ScriptResponseParameters" : {
        "ParameterDescription" : "description2",
        "ColumnName" : "column2",
        "ParameterName" : "param2",
        "ParameterDataType" : 0,
        "ExampleValue" : "example2"
      },
      "ScriptConnection" : {
        "TableName" : "t",
        "ConnectionId" : 123
      }
    },
    "WizardDetails" : {
      "IsPagedResponse" : true,
      "WizardRequestParameters" : {
        "ColumnName" : "column1",
        "ParameterName" : "param1",
        "ParameterPosition" : 0,
        "ParameterDescription" : "description1",
        "DefaultValue" : "default1",
        "ParameterOperator" : 0,
        "ParameterDataType" : 0,
        "ExampleValue" : "example1",
        "IsRequiredParameter" : true
      },
      "WizardResponseParameters" : {
        "ParameterDescription" : "description2",
        "ColumnName" : "column2",
        "ParameterName" : "param2",
        "ParameterDataType" : 0,
        "ExampleValue" : "example2"
      },
      "WizardConnection" : {
        "TableName" : "t",
        "ConnectionId" : 123
      }
    }
  }
}

错误码

HttpCode	错误码	错误信息	描述
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.	您的请求过于频繁，请尝试放缓请求速度。
500	InternalError.System	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	系统内部错误，请稍后再试。

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