GetDataServiceApi - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	GetDataServiceApi	A operação a ser executada. Defina o valor como GetDataServiceApi.
TenantId	Long	Não	10002	O ID do locatário.
ProjectId	Long	Sim	10001	O ID do workspace.
ApiId	Long	Sim	10000	O ID da API.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
HttpStatusCode	Integer	200	O código de status HTTP.
RequestId	String	0000-ABCD-EFG****	O ID da solicitação.
ErrorMessage	String	The specified parameters are invalid.	A mensagem de erro.
Success	Boolean	true	Indica se a solicitação foi bem-sucedida.
ErrorCode	String	1031203110005	O código de erro.
Data	Object		Os dados retornados.
Timeout	Integer	10000	O tempo limite da solicitação da API. Unidade: milissegundos.
Status	Integer	0	O status da API. Valores válidos: 0 e 1. O valor 0 indica que a API não está publicada. O valor 1 indica que a API está publicada.
ApiId	Long	10000	O ID da API.
ApiMode	Integer	0	O tipo da API. Valores válidos: 0, 1 e 2. O valor 0 indica que a API foi gerada no modo assistente. O valor 1 indica que a API foi gerada no modo script. O valor 2 indica que a API foi gerada por registro.
ProjectId	Long	10001	O ID do workspace.
ResponseContentType	Integer	0	O formato de retorno da resposta da solicitação da API. Valores válidos: 0 e 1. O valor 0 indica o formato JSON. O valor 1 indica o formato XML. APIs geradas nos modos assistente ou script suportam o formato JSON. APIs geradas por registro suportam os formatos JSON e XML.
CreatorId	String	1234567	O ID da conta Alibaba Cloud usada pelo criador da API.
VisibleRange	Integer	0	O escopo de visibilidade da API. Valores válidos: 0 e 1. O valor 0 indica que a API é visível dentro do workspace. O valor 1 indica que a API é visível apenas para seu proprietário.
ModifiedTime	String	2020-06-23T00:21:01+0800	A hora da última modificação da API.
OperatorId	String	2345678	O ID da conta Alibaba Cloud do usuário que modificou a API pela última vez.
GroupId	String	ab123****	O ID do grupo.
Description	String	Description of the test API	A descrição da API.
FolderId	Long	0	O ID da pasta.
RequestMethod	Integer	0	O método de solicitação da API. Valores válidos: 0, 1, 2 e 3. O valor 0 indica o método GET. O valor 1 indica o método POST. O valor 2 indica o método PUT. O valor 3 indica o método DELETE. APIs geradas nos modos assistente ou script suportam os métodos GET e POST. APIs geradas por registro suportam os métodos GET, POST, PUT e DELETE.
CreatedTime	String	2020-06-23T00:21:01+0800	A hora de criação da API.
ApiName	String	Name of the test API	O nome da API.
TenantId	Long	10002	O ID do locatário.
ApiPath	String	/test/1	O caminho da API.
Protocols	Array of Integer	0	O protocolo usado pela API. Valores válidos: 0 e 1. O valor 0 indica HTTP. O valor 1 indica HTTPS. Múltiplos protocolos são apresentados em uma lista.
RegistrationDetails	Object		Os detalhes da API gerada por registro. Este parâmetro é retornado apenas se a API for gerada por registro.
ServiceHost	String	http://example.aliyundoc.com	A URL do serviço de back-end.
ServiceContentType	Integer	0	O formato de retorno da resposta da solicitação da API. Valores válidos: 0: JSON 1: XML APIs geradas nos modos assistente ou script suportam o formato JSON. APIs geradas por registro suportam os formatos JSON e XML.
ServicePath	String	/index	O caminho do serviço de back-end.
SuccessfulResultSample	String	{"success": true}	A amostra de resposta de sucesso da API.
FailedResultSample	String	{"success": false}	A amostra de resposta de erro da API.
ServiceRequestBodyDescription	String	{"abc":1}	A descrição do corpo da solicitação iniciada para chamar o serviço de back-end.
RegistrationErrorCodes	Array of RegistrationErrorCode		Os códigos de erro retornados para a API gerada por registro.
ErrorMessage	String	fail to call	A mensagem de erro.
ErrorCode	String	1001	O código de erro.
ErrorSolution	String	retry	A solução usada para corrigir o erro.
RegistrationRequestParameters	Array of RegistrationRequestParameter		Os parâmetros de solicitação da API gerada por registro.
ColumnName	String	column1	O nome do campo associado. Este parâmetro tem suporte apenas se a API for gerada no modo assistente.
ParameterName	String	name1	O nome do parâmetro.
ParameterPosition	Integer	0	A posição do parâmetro. Valores válidos: 0: indica que o parâmetro está no caminho da URL da solicitação. 1: indica que o parâmetro está no parâmetro Query da URL da solicitação. 2: indica que o parâmetro está no cabeçalho da solicitação. 3: indica que o parâmetro está no corpo da solicitação. APIs geradas nos modos assistente ou script suportam apenas a posição Query. APIs geradas por registro com método de solicitação GET ou DELETE suportam as posições Query e Head. APIs geradas por registro com método de solicitação PUT ou POST suportam as posições Query, Head e Body.
ParameterDescription	String	description1	A descrição.
DefaultValue	String	default1	O valor padrão.
ParameterOperator	Integer	0	O operador usado para o valor do parâmetro. Valores válidos: 0: Equal 1: Like 2: Const 3: In APIs geradas no modo assistente suportam os operadores Equal, Like e In. APIs geradas no modo script suportam o operador Equal. APIs geradas por registro suportam os operadores Equal e Const.
ParameterDataType	Integer	0	O tipo de dados do parâmetro. Valores válidos: 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	O valor de exemplo.
IsRequiredParameter	Boolean	true	Indica se o parâmetro é obrigatório.
ScriptDetails	Object		Os detalhes da API gerada no modo script. Este parâmetro é retornado apenas se a API for gerada no modo script.
Script	String	select a from t	O script SQL.
IsPagedResponse	Boolean	true	Indica se as entradas são retornadas por página.
ScriptRequestParameters	Array of ScriptRequestParameter		Os parâmetros de solicitação da API gerada no modo script.
ColumnName	String	column1	O nome do campo associado. Este parâmetro tem suporte apenas se a API for gerada no modo assistente.
ParameterName	String	param1	O nome do parâmetro.
ParameterPosition	Integer	0	A posição do parâmetro. Valores válidos: 0, 1, 2 e 3. O valor 0 indica que o parâmetro está no caminho da URL da solicitação. O valor 1 indica que o parâmetro está no parâmetro Query da URL da solicitação. O valor 2 indica que o parâmetro está no cabeçalho da solicitação. O valor 3 indica que o parâmetro está no corpo da solicitação. APIs geradas nos modos assistente ou script suportam apenas a posição Query. APIs geradas por registro com método de solicitação GET ou DELETE suportam as posições Query e Head. APIs geradas por registro com método de solicitação PUT ou POST suportam as posições Query, Head e Body.
ParameterDescription	String	description1	A descrição.
DefaultValue	String	default1	O valor padrão.
ParameterOperator	Integer	0	O operador usado para o valor do parâmetro. Valores válidos: 0, 1, 2 e 3. O valor 0 indica o operador Equal. O valor 1 indica o operador Like. O valor 2 indica o operador Const. O valor 3 indica o operador In. APIs geradas no modo assistente suportam os operadores Equal, Like e In. APIs geradas no modo script suportam o operador Equal. APIs geradas por registro suportam os operadores Equal e Const.
ParameterDataType	Integer	0	O tipo de dados do parâmetro. Valores válidos: 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	O valor de exemplo.
IsRequiredParameter	Boolean	true	Indica se o parâmetro é obrigatório.
ScriptResponseParameters	Array of ScriptResponseParameter		Os parâmetros de resposta da API gerada no modo script.
ParameterDescription	String	description2	A descrição.
ColumnName	String	column2	O nome do campo associado. Este parâmetro tem suporte apenas se a API for gerada no modo assistente.
ParameterName	String	param2	O nome do parâmetro.
ParameterDataType	Integer	0	O tipo de dados do parâmetro. Valores válidos: 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	O valor de exemplo.
ScriptConnection	Object		As informações da fonte de dados da API gerada no modo script.
TableName	String	t	O nome da tabela na fonte de dados.
ConnectionId	Long	123	O ID da fonte de dados.
WizardDetails	Object		Os detalhes da API gerada no modo assistente. Este parâmetro é retornado apenas se a API for gerada no modo assistente.
IsPagedResponse	Boolean	true	Indica se as entradas são retornadas por página.
WizardRequestParameters	Array of WizardRequestParameter		Os parâmetros de solicitação da API gerada no modo assistente.
ColumnName	String	column1	O nome do campo associado. Este parâmetro tem suporte apenas se a API for gerada no modo assistente.
ParameterName	String	param1	O nome do parâmetro.
ParameterPosition	Integer	0	A posição do parâmetro. Valores válidos: 0, 1, 2 e 3. O valor 0 indica que o parâmetro está no caminho da URL da solicitação. O valor 1 indica que o parâmetro está no parâmetro Query da URL da solicitação. O valor 2 indica que o parâmetro está no cabeçalho da solicitação. O valor 3 indica que o parâmetro está no corpo da solicitação. APIs geradas nos modos assistente ou script suportam apenas a posição Query. APIs geradas por registro com método de solicitação GET ou DELETE suportam as posições Query e Head. APIs geradas por registro com método de solicitação PUT ou POST suportam as posições Query, Head e Body.
ParameterDescription	String	description1	A descrição.
DefaultValue	String	default1	O valor padrão.
ParameterOperator	Integer	0	O operador usado para o valor do parâmetro. Valores válidos: 0, 1, 2 e 3. O valor 0 indica o operador Equal. O valor 1 indica o operador Like. O valor 2 indica o operador Const. O valor 3 indica o operador In. APIs geradas no modo assistente suportam os operadores Equal, Like e In. APIs geradas no modo script suportam o operador Equal. APIs geradas por registro suportam os operadores Equal e Const.
ParameterDataType	Integer	0	O tipo de dados do parâmetro. Valores válidos: 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	O valor de exemplo.
IsRequiredParameter	Boolean	true	Indica se o parâmetro é obrigatório.
WizardResponseParameters	Array of WizardResponseParameter		Os parâmetros de resposta da API gerada no modo assistente.
ParameterDescription	String	description2	A descrição.
ColumnName	String	column2	O nome do campo associado. Este parâmetro tem suporte apenas se a API for gerada no modo assistente.
ParameterName	String	param2	O nome do parâmetro.
ParameterDataType	Integer	0	O tipo de dados do parâmetro. Valores válidos: 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	O valor de exemplo.
WizardConnection	Object		As informações da fonte de dados da API gerada no modo assistente.
TableName	String	t	O nome da tabela na fonte de dados.
ConnectionId	Long	123	O ID da fonte de dados.

Os detalhes de diferentes tipos de APIs são retornados em parâmetros distintos. Os detalhes de uma API gerada no modo assistente aparecem no parâmetro WizardDetails. Os detalhes de uma API gerada no modo script aparecem no parâmetro ScriptDetails. Já os detalhes de uma API gerada por registro constam no parâmetro RegistrationDetails.

Exemplos

Solicitações de exemplo

http(s)://[Endpoint]/?Action=GetDataServiceApi
&TenantId=10002
&ProjectId=10001
&ApiId=10000
&<Common request parameters>

Respostas de sucesso de exemplo

Formato 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>Description of the test API</Description>
        <FolderId>0</FolderId>
        <RequestMethod>0</RequestMethod>
        <CreatedTime>2020-06-23T00:21:01+0800</CreatedTime>
        <ApiName>Name of the test 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>

Formato 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" : "Description of the test API",
    "FolderId" : 0,
    "RequestMethod" : 0,
    "CreatedTime" : "2020-06-23T00:21:01+0800",
    "ApiName" : "Name of the test 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
      }
    }
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
429	Throttling.Api	The request for this resource has exceeded your available limit.	O número de solicitações para o recurso excedeu o limite superior.
429	Throttling.System	The DataWorks system is busy. Try again later.	O sistema do DataWorks está ocupado. Tente novamente mais tarde.
429	Throttling.User	Your request is too frequent. Try again later.	Foram enviadas solicitações excessivas em um curto período. Tente novamente mais tarde.
500	InternalError.System	An internal system error occurred. Try again later.	Ocorreu um erro interno. Tente novamente mais tarde.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	Ocorreu um erro interno. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.